Deveel.Data.Security.UserManager Class Reference

Inheritance diagram for Deveel.Data.Security.UserManager:

Public Member Functions
	UserManager (IQuery queryContext)
void	Dispose ()
bool	UserExists (string userName)
void	CreateUser (UserInfo userInfo, string identifier)
bool	DropUser (string userName)
void	AlterUser (UserInfo userInfo, string identifier)
void	SetUserStatus (string userName, UserStatus status)
UserStatus	GetUserStatus (string userName)
UserInfo	GetUser (string userName)
bool	CheckIdentifier (string userName, string identifier)
void	CreateUserGroup (string groupName)
bool	DropUserGroup (string groupName)
bool	UserGroupExists (string groupName)
void	AddUserToGroup (string userName, string groupName, bool asAdmin)
bool	IsUserGroupAdmin (string userName, string groupName)
bool	RemoveUserFromGroup (string userName, string groupName)
bool	IsUserInGroup (string userName, string groupName)
string[]	GetUserGroups (string userName)

Protected Member Functions
virtual void	Dispose (bool disposing)

Properties
IQuery	QueryContext [get, private set]

Private Member Functions
	~UserManager ()
string[]	QueryUserGroups (string userName)
bool	TryGetUserGroupsFromCache (string userName, out string[] groups)
void	ClearUserGroupsCache (string userName)
void	ClearUserGroupsCache ()
void	SetUserGroupsInCache (string userName, string[] groups)
void	RemoveUserFromAllGroups (string username)

Static Private Member Functions
static byte[]	SerializeArguments (IDictionary< string, object > args)
static IDictionary< string, object >	DeserializeArguments (byte[] bytes)

Private Attributes
Dictionary< string, string[]>	userGroupsCache

Detailed Description

Definition at line 27 of file UserManager.cs.

Constructor & Destructor Documentation

Deveel.Data.Security.UserManager.UserManager ( IQuery  queryContext )

inline

Definition at line 30 of file UserManager.cs.

                                                {
            QueryContext = queryContext;
        }

Deveel.Data.Security.UserManager.~UserManager ( )

inlineprivate

Definition at line 34 of file UserManager.cs.

                       {
            Dispose(false);
        }

Member Function Documentation

void Deveel.Data.Security.UserManager.AddUserToGroup ( string  userName, string  groupName, bool  asAdmin  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 378 of file UserManager.cs.

                                                                                    {
            if (String.IsNullOrEmpty(groupName))
                throw new ArgumentNullException("group");
            if (String.IsNullOrEmpty(userName))
                throw new ArgumentNullException("username");

            char c = groupName[0];
            if (c == '@' || c == '&' || c == '#' || c == '$')
                throw new ArgumentException(String.Format("Group name '{0}' is invalid: cannot start with {1}", groupName, c), "groupName");

            if (!IsUserInGroup(userName, groupName)) {
                var table = QueryContext.GetMutableTable(SystemSchema.UserGroupTableName);
                var row = table.NewRow();
                row.SetValue(0, userName);
                row.SetValue(1, groupName);
                row.SetValue(2, asAdmin);
                table.AddRow(row);
            }
        }

void Deveel.Data.Security.UserManager.AlterUser ( UserInfo  userInfo, string  identifier  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 233 of file UserManager.cs.

                                                                    {
            var userName = userInfo.Name;

            var userExpr = SqlExpression.Constant(DataObject.String(userName));

            // Delete the current username from the 'password' table
            var table = QueryContext.GetMutableTable(SystemSchema.PasswordTableName);
            var c1 = table.GetResolvedColumnName(0);
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, userExpr);
            if (t.RowCount != 1)
                throw new SecurityException(String.Format("User '{0}' was not found.", userName));

            table.Delete(t);

            // TODO: get the hash algorithm and hash ...

            var method = userInfo.Identification.Method;
            var methodArgs = SerializeArguments(userInfo.Identification.Arguments);

            if (method != "plain")
                throw new NotImplementedException("Only mechanism implemented right now is plain text (it sucks!)");

            // Add the new username
            table = QueryContext.GetMutableTable(SystemSchema.PasswordTableName);
            var row = table.NewRow();
            row.SetValue(0, userName);
            row.SetValue(1, method);
            row.SetValue(2, methodArgs);
            row.SetValue(3, identifier);
            table.AddRow(row);

        }

bool Deveel.Data.Security.UserManager.CheckIdentifier ( string  userName, string  identifier  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 323 of file UserManager.cs.

                                                                        {
            var table = QueryContext.GetTable(SystemSchema.PasswordTableName);
            var unameColumn = table.GetResolvedColumnName(0);
            var idColumn = table.GetResolvedColumnName(3);

            var t = table.SimpleSelect(QueryContext, unameColumn, SqlExpressionType.Equal, SqlExpression.Constant(userName));
            if (t.RowCount == 0)
                throw new SecurityException(String.Format("User '{0}' is not registered.", userName));

            var stored = t.GetValue(0, idColumn);
            return stored.Value.ToString().Equals(identifier);
        }

void Deveel.Data.Security.UserManager.ClearUserGroupsCache ( string  userName )

inlineprivate

Definition at line 174 of file UserManager.cs.

                                                           {
            if (userGroupsCache == null)
                return;

            userGroupsCache.Remove(userName);
        }

void Deveel.Data.Security.UserManager.ClearUserGroupsCache ( )

inlineprivate

Definition at line 181 of file UserManager.cs.

                                            {
            if (userGroupsCache == null)
                return;

            userGroupsCache.Clear();
        }

void Deveel.Data.Security.UserManager.CreateUser ( UserInfo  userInfo, string  identifier  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 59 of file UserManager.cs.

                                                                     {
            if (userInfo == null)
                throw new ArgumentNullException("userInfo");
            if (String.IsNullOrEmpty(identifier))
                throw new ArgumentNullException("identifier");

            // TODO: make these rules configurable?

            var userName = userInfo.Name;

            if (UserExists(userName))
                throw new SecurityException(String.Format("User '{0}' is already registered.", userName));

            // Add to the key 'user' table
            var table = QueryContext.GetMutableTable(SystemSchema.UserTableName);
            var row = table.NewRow();
            row[0] = DataObject.String(userName);
            table.AddRow(row);

            var method = userInfo.Identification.Method;
            var methodArgs = SerializeArguments(userInfo.Identification.Arguments);

            if (method != "plain")
                throw new NotImplementedException("Only mechanism implemented right now is plain text (it sucks!)");

            table = QueryContext.GetMutableTable(SystemSchema.PasswordTableName);
            row = table.NewRow();
            row.SetValue(0, userName);
            row.SetValue(1, method);
            row.SetValue(2, methodArgs);
            row.SetValue(3, identifier);
            table.AddRow(row);
        }

void Deveel.Data.Security.UserManager.CreateUserGroup ( string  groupName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 337 of file UserManager.cs.

                                                      {
            if (String.IsNullOrEmpty(groupName))
                throw new ArgumentNullException("groupName");

            var c = groupName[0];
            if (c == '$' || c == '%' || c == '@')
                throw new ArgumentException(String.Format("Group name '{0}' starts with an invalid character.", groupName));

            var table = QueryContext.GetMutableTable(SystemSchema.GroupsTableName);

            var row = table.NewRow();
            row.SetValue(0, groupName);

            table.AddRow(row);
        }

static IDictionary<string, object> Deveel.Data.Security.UserManager.DeserializeArguments ( byte[]  bytes )

inlinestaticprivate

Definition at line 122 of file UserManager.cs.

                                                                                      {
            using (var stream = new MemoryStream(bytes)) {
                using (var reader = new BinaryReader(stream)) {
                    var argCount = reader.ReadInt32();

                    var args = new Dictionary<string, object>(argCount);
                    for (int i = 0; i < argCount; i++) {
                        var argName = reader.ReadString();
                        var argType = reader.ReadByte();
                        object value = null;
                        if (argType == 1) {
                            value = reader.ReadBoolean();
                        } else if (argType == 2) {
                            value = reader.ReadInt64();
                        } else if (argType == 3) {
                            value = reader.ReadString();
                        }

                        args[argName] = value;
                    }

                    return args;
                }
            }
        }

void Deveel.Data.Security.UserManager.Dispose ( )

inline

Definition at line 40 of file UserManager.cs.

                              {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

virtual void Deveel.Data.Security.UserManager.Dispose ( bool  disposing )

inlineprotectedvirtual

Definition at line 45 of file UserManager.cs.

                                                       {
            userGroupsCache = null;
            QueryContext = null;
        }

bool Deveel.Data.Security.UserManager.DropUser ( string  userName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 196 of file UserManager.cs.

                                              {
            var userExpr = SqlExpression.Constant(DataObject.String(userName));

            RemoveUserFromAllGroups(userName);

            // TODO: Remove all object-level privileges from the user...

            //var table = QueryContext.GetMutableTable(SystemSchema.UserConnectPrivilegesTableName);
            //var c1 = table.GetResolvedColumnName(0);
            //var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, userExpr);
            //table.Delete(t);

            var table = QueryContext.GetMutableTable(SystemSchema.PasswordTableName);
            var c1 = table.GetResolvedColumnName(0);
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, userExpr);
            table.Delete(t);

            table = QueryContext.GetMutableTable(SystemSchema.UserTableName);
            c1 = table.GetResolvedColumnName(0);
            t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, userExpr);
            return table.Delete(t) > 0;
        }

bool Deveel.Data.Security.UserManager.DropUserGroup ( string  groupName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 353 of file UserManager.cs.

                                                    {
            var table = QueryContext.GetMutableTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);

            // All password where name = %groupName%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(groupName));

            if (t.RowCount > 0) {
                table.Delete(t);
                ClearUserGroupsCache();
                return true;
            }

            return false;
        }

UserInfo Deveel.Data.Security.UserManager.GetUser ( string  userName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 300 of file UserManager.cs.

                                                 {
            var table = QueryContext.GetTable(SystemSchema.PasswordTableName);
            var unameColumn = table.GetResolvedColumnName(0);
            var methodColumn = table.GetResolvedColumnName(1);
            var methodArgsColumn = table.GetResolvedColumnName(2);

            var t = table.SimpleSelect(QueryContext, unameColumn, SqlExpressionType.Equal, SqlExpression.Constant(userName));
            if (t.RowCount == 0)
                throw new SecurityException(String.Format("User '{0}' is not registered.", userName));

            var method = t.GetValue(0, methodColumn);
            var methodArgs = t.GetValue(0, methodArgsColumn);
            var argBytes = ((SqlBinary) methodArgs.Value).ToByteArray();
            var args = DeserializeArguments(argBytes);

            var identification = new UserIdentification(method);
            foreach (var arg in args) {
                identification.Arguments[arg.Key] = arg.Value;
            }

            return new UserInfo(userName, identification);
        }

string [] Deveel.Data.Security.UserManager.GetUserGroups ( string  userName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 460 of file UserManager.cs.

                                                       {
            string[] groups;
            if (!TryGetUserGroupsFromCache(userName, out groups)) {
                groups = QueryUserGroups(userName);
                SetUserGroupsInCache(userName, groups);
            }

            return groups;
        }

UserStatus Deveel.Data.Security.UserManager.GetUserStatus ( string  userName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 293 of file UserManager.cs.

                                                         {
            if (IsUserInGroup(userName, SystemGroups.LockGroup))
                return UserStatus.Locked;

            return UserStatus.Unlocked;
        }

bool Deveel.Data.Security.UserManager.IsUserGroupAdmin ( string  userName, string  groupName  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 398 of file UserManager.cs.

                                                                        {
            // This is a special query that needs to access the lowest level of ITable, skipping
            // other security controls
            var table = QueryContext.GetTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);
            var c2 = table.GetResolvedColumnName(1);

            // All 'user_group' where UserName = %username%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(userName));

            // All from this set where PrivGroupName = %group%
            t = t.SimpleSelect(QueryContext, c2, SqlExpressionType.Equal, SqlExpression.Constant(groupName));
            if (t.RowCount == 0)
                return false;

            return t.GetValue(0, 2).AsBoolean();
        }

bool Deveel.Data.Security.UserManager.IsUserInGroup ( string  userName, string  groupName  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 440 of file UserManager.cs.

                                                                     {
            string[] userGroups;
            if (TryGetUserGroupsFromCache(userName, out userGroups) &&
                userGroups.Any(x => String.Equals(groupName, x, StringComparison.OrdinalIgnoreCase)))
                return true;

            // This is a special query that needs to access the lowest level of ITable, skipping
            // other security controls
            var table = QueryContext.GetTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);
            var c2 = table.GetResolvedColumnName(1);

            // All 'user_group' where UserName = %username%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(userName));

            // All from this set where PrivGroupName = %group%
            t = t.SimpleSelect(QueryContext, c2, SqlExpressionType.Equal, SqlExpression.Constant(groupName));
            return t.RowCount > 0;
        }

string [] Deveel.Data.Security.UserManager.QueryUserGroups ( string  userName )

inlineprivate

Definition at line 148 of file UserManager.cs.

                                                          {
            var table = QueryContext.GetTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);
            // All 'user_group' where UserName = %username%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(DataObject.String(userName)));
            int sz = t.RowCount;
            var groups = new string[sz];
            var rowEnum = t.GetEnumerator();
            int i = 0;
            while (rowEnum.MoveNext()) {
                groups[i] = t.GetValue(rowEnum.Current.RowId.RowNumber, 1).Value.ToString();
                ++i;
            }

            return groups;
        }

void Deveel.Data.Security.UserManager.RemoveUserFromAllGroups ( string  username )

inlineprivate

Definition at line 219 of file UserManager.cs.

                                                              {
            var userExpr = SqlExpression.Constant(DataObject.String(username));

            var table = QueryContext.GetMutableTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, userExpr);

            if (t.RowCount > 0) {
                table.Delete(t);

                ClearUserGroupsCache(username);
            }
        }

bool Deveel.Data.Security.UserManager.RemoveUserFromGroup ( string  userName, string  groupName  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 416 of file UserManager.cs.

                                                                           {
            // This is a special query that needs to access the lowest level of ITable, skipping
            // other security controls
            var table = QueryContext.GetMutableTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);
            var c2 = table.GetResolvedColumnName(1);

            // All 'user_group' where UserName = %username%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(userName));

            // All from this set where PrivGroupName = %group%
            t = t.SimpleSelect(QueryContext, c2, SqlExpressionType.Equal, SqlExpression.Constant(groupName));

            if (t.RowCount > 0) {
                table.Delete(t);

                ClearUserGroupsCache(userName);

                return true;
            }

            return false;
        }

static byte [] Deveel.Data.Security.UserManager.SerializeArguments ( IDictionary< string, object >  args )

inlinestaticprivate

Definition at line 93 of file UserManager.cs.

                                                                                   {
            using (var stream = new MemoryStream()) {
                using (var writer = new BinaryWriter(stream)) {
                    writer.Write(args.Count);

                    foreach (var arg in args) {
                        writer.Write(arg.Key);

                        if (arg.Value is bool) {
                            writer.Write((byte)1);
                            writer.Write((bool) arg.Value);
                        } else if (arg.Value is short ||
                                   arg.Value is int ||
                                   arg.Value is long) {
                            var value = (long) arg.Value;
                            writer.Write((byte)2);
                            writer.Write(value);
                        } else if (arg.Value is string) {
                            writer.Write((byte)3);
                            writer.Write((string) arg.Value);
                        }
                    }

                    writer.Flush();
                    return stream.ToArray();
                }
            }
        }

void Deveel.Data.Security.UserManager.SetUserGroupsInCache ( string  userName, string[]  groups  )

inlineprivate

Definition at line 188 of file UserManager.cs.

                                                                            {
            if (userGroupsCache == null)
                userGroupsCache = new Dictionary<string, string[]>();

            userGroupsCache[userName] = groups;
        }

void Deveel.Data.Security.UserManager.SetUserStatus ( string  userName, UserStatus  status  )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 266 of file UserManager.cs.

                                                                      {
            // Internally we implement this by adding the user to the #locked group.
            var table = QueryContext.GetMutableTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);
            var c2 = table.GetResolvedColumnName(1);
            // All 'user_group' where UserName = %username%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(userName));
            // All from this set where PrivGroupName = %group%
            t = t.SimpleSelect(QueryContext, c2, SqlExpressionType.Equal, SqlExpression.Constant(SystemGroups.LockGroup));

            bool userBelongsToLockGroup = t.RowCount > 0;
            if (status == UserStatus.Locked &&
                !userBelongsToLockGroup) {
                // Lock the user by adding the user to the Lock group
                // Add this user to the locked group.
                var rdat = new Row(table);
                rdat.SetValue(0, userName);
                rdat.SetValue(1, SystemGroups.LockGroup);
                table.AddRow(rdat);
            } else if (status == UserStatus.Unlocked &&
                userBelongsToLockGroup) {
                // Unlock the user by removing the user from the Lock group
                // Remove this user from the locked group.
                table.Delete(t);
            }
        }

bool Deveel.Data.Security.UserManager.TryGetUserGroupsFromCache ( string  userName, out string[]  groups  )

inlineprivate

Definition at line 165 of file UserManager.cs.

                                                                                     {
            if (userGroupsCache == null) {
                groups = null;
                return false;
            }

            return userGroupsCache.TryGetValue(userName, out groups);
        }

bool Deveel.Data.Security.UserManager.UserExists ( string  userName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 50 of file UserManager.cs.

                                                {
            var table = QueryContext.GetTable(SystemSchema.UserTableName);
            var c1 = table.GetResolvedColumnName(0);

            // All password where UserName = %username%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(userName));
            return t.RowCount > 0;
        }

bool Deveel.Data.Security.UserManager.UserGroupExists ( string  groupName )

inline

Implements Deveel.Data.Security.IUserManager.

Definition at line 369 of file UserManager.cs.

                                                      {
            var table = QueryContext.GetTable(SystemSchema.UserGroupTableName);
            var c1 = table.GetResolvedColumnName(0);

            // All password where name = %groupName%
            var t = table.SimpleSelect(QueryContext, c1, SqlExpressionType.Equal, SqlExpression.Constant(groupName));
            return t.RowCount > 0;
        }

Member Data Documentation

Dictionary<string, string[]> Deveel.Data.Security.UserManager.userGroupsCache

private

Definition at line 28 of file UserManager.cs.

Property Documentation

IQuery Deveel.Data.Security.UserManager.QueryContext

getprivate set

Definition at line 38 of file UserManager.cs.

---

The documentation for this class was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Security/UserManager.cs