summaryrefslogtreecommitdiffhomepage
path: root/src/kernel/KernelKit/UserMgr.h
blob: e622c376fee45023e54ae20b36571e176e91ea26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
// Copyright 2024-2025, Amlal El Mahrouss (amlal@nekernel.org)
// Licensed under the Apache License, Version 2.0 (see LICENSE file)
// Official repository: https://github.com/nekernel-org/nekernel

#ifndef KERNELKIT_USERMGR_H
#define KERNELKIT_USERMGR_H

/* ========================================

 Revision History:

 04/03/25: Set users directory as /users/ instead of /usr/

 ======================================== */

#include <CompilerKit/CompilerKit.h>
#include <KernelKit/KPC.h>
#include <NeKit/Config.h>
#include <NeKit/KString.h>

///! We got the MGMT, STD (%s format) and GUEST users,
///! all are used to make authorized operations.
#define kMgmtUser "NEKERNEL/MGMT/%s"
#define kGuestUser "NEKERNEL/GUEST/%s"
#define kStdUser "NEKERNEL/STD/%s"

#define kUsersDir "/users/"

#define kMaxUserNameLen (256U)
#define kMaxUserTokenLen (256U)

namespace Kernel {
class User;

enum struct UserRingKind : Int32 {
  kRingInvalid   = 0,
  kRingStdUser   = 444,
  kRingSuperUser = 666,
  kRingGuestUser = 777,
  kRingCount     = 3,
};

using UserPublicKey     = Char*;
using UserPublicKeyType = Char;

/// @brief System User class.
class User final {
 public:
  User() = delete;

  User(const Int32& sel, const Char* username);
  User(const UserRingKind& kind, const Char* username);

  ~User();

 public:
  NE_COPY_DEFAULT(User)

 public:
  bool operator==(const User& lhs);
  bool operator!=(const User& lhs);

 public:
  /// @brief Get software ring
  const UserRingKind& Ring();

  /// @brief Get user name
  Char* Name();

  /// @brief Is he a standard user?
  Bool IsStdUser();

  /// @brief Is she a super user?
  Bool IsSuperUser();

  /// @brief Saves a password from the public key.
  Bool Save(const UserPublicKey password);

  /// @brief Checks if a password matches the **password**.
  /// @param password the password to check.
  Bool Login(const UserPublicKey password);

 private:
  UserRingKind mUserRing{UserRingKind::kRingStdUser};
  Char         mUserName[kMaxUserNameLen] = {0};
  UInt64       mUserFNV{0UL};
};

/// \brief Alias for user ptr.
using UserPtr = User*;

/// \brief Current running user.
inline User* kCurrentUser = nullptr;

/// \brief Super user.
inline User* kRootUser = nullptr;
}  // namespace Kernel

#endif /* ifndef KERNELKIT_USERMGR_H */