USER(3) Library Functions Manual USER(3)

UserConvenience functions for working with local users.

#include <User.h>

UserValidate(char *, char *);

UserHistoricalValidate(char *, char *);

UserExists(Db *, char *);

User *
UserCreate(Db *, char *, char *);

User *
UserLock(Db *, char *);

User *
UserAuthenticate(Db *, char *);

UserUnlock(User *);

UserLoginInfo *
UserLogin(User *, char *, char *, char *, int);

char *
UserGetName(User *);

UserCheckPassword(User *, char *);

UserSetPassword(User *, char *);

UserDeactivate(User *);

HashMap *
UserGetDevices(User *);

UserAccessToken *
UserGenerateAccessToken(User *, char *, int);

UserAccessTokenSave(Db *, UserAccessToken *);

UserAccessTokenFree(UserAccessToken *);

UserDeleteToken(User *, char *);

UserDeleteTokens(User *);

UserId *
UserIdParse(char *, char *);

UserIdFree(UserId *);

The User API provides a wrapper over the database and offers an easy way for managing local users. It supports all of the locking mechanisms that the database does, and provides features for authenticating local users, among other tasks.

typedef struct UserLoginInfo
    UserAccessToken *accessToken;
    char *refreshToken;
} UserLoginInfo;

typedef struct UserAccessToken
    char *user;
    char *string;
    char *deviceId;
    long lifetime;
} UserAccessToken;

typedef struct UserId
    char *localpart;
    char *server;
} UserId;

() takes a localpart and domain as separate parameters and validates it against the rules of the Matrix specification. The reason the domain is required is because the spec imposes limitations on the length of the user name, and the longer the domain name is, the shorter the local part can be. This function is used to ensure that client-provided localparts are valid on this server. () is called the exact same way, except it is a little more lenient. It is used to validate user parts on other servers, since some usernames might exist that are not fully spec compliant, but remain in use due to historical reasons.

() takes a localpart and checks whether or not it exists in the database.

() creates a new user. It takes a localpart, which is assumed to be valid, and a password.

() takes a localpart and obtains a database reference to the user represented by that localpart. It behaves analogously to (), and in fact uses it under the hood to ensure that the user can only be modified by the thread that has locked the user. () returns the user reference back to the database. It uses () under the hood.

() takes an access token, figures out what user it belongs to, and returns the reference to that user. This function should be used by most endpoints that require valid user authentication, since most endpoints are authenticated via access tokens.

() is used for logging in a user. It takes the user's password, device ID, device display name, and a boolean value indicating whether or not the client supports refresh tokens. This function logs in the user and generates an access token to be returned to the client.

() gets the name attached to a user object. It can be used for the few cases where it's necessary to know the localpart of a user.

() takes a password and verifies it against a user object. Telodendria does not store passwords in plain text, so this function hashes the password and and checks it against what's stored in the database.

() resets the given user's password by hashing a plain text password and storing it in the database.

() deactivates a user such that it can no longer be used to log in, but the username is still taken. This is to prevent future users from pretending to be previous users of a given localpart.

() fetches the devices that belong to the user, in JSON format, identical to what's stored in the database. In fact, this JSON is still linked to the database, so it should not be freed with ().

(), (), and () are used for managing individual access tokens on a user. They operate on the UserAccessToken structure. UserAccessTokenGenerate() takes the user localpart to generate the token for, the device ID, for the token, and a boolean value indicating whether or not the token should expire. UserAccessTokenSave() writes the access token to the database.

() and () delete a specific access token/refresh token pair, or all the access and refresh tokens for a given user, respectively.

() parses either a localpart or a fully-qualified Matrix ID. () frees the result of this parsing.

UserValidate(), UserHistoricalValidate(), UserExists(), UserUnlock(), UserCheckPassword(), UserSetPassword(), UserDeactivate(), UserAccessTokenSave(), UserDeleteToken(), and UserDeleteTokens() all return a boolean value. Non-zero values indicate success, and zero values indicate failure.

UserCreate(), UserLock(), and UserAuthenticate() return a pointer to a User, or NULL if an error occurred.

UserGetName() returns a pointer to the string that holds the localpart of the user represented by the given user pointer. This pointer should not be freed by the caller , as it is used internally and will be freed when the user is unlocked.

UserLogin() returns a UserLoginInfo struct, or NULL if something goes wrong. All this information should be returned to the client that is logging in. If the client doesn't support refresh tokens, then refreshToken will be NULL.

UserGetDevices() returns a JSON object that is linked to the database, or NULL if there was an error. The result should not be freed with JsonFree() because it is still directly attached to the database. This object is an exact representation of what is stored on the disk.

UserAccessTokenGenerate() generates an access token structure that should be freed when it is no longer needed, or NULL if there was a memory error.

UserIdParse() returns a UserId structure that should be freed when it is no longer needed, or NULL if there was a memory error.


March 6, 2023 Telodendria Project