GSAD user handling.
More...
#include "gsad_params.h"
#include <glib.h>
Go to the source code of this file.
|
void | user_free (user_t *user) |
|
user_t * | user_copy (user_t *user) |
|
int | user_find (const gchar *cookie, const gchar *token, const char *address, user_t **user_return) |
| Find a user, given a token and cookie. More...
|
|
user_t * | user_add (const gchar *username, const gchar *password, const gchar *timezone, const gchar *role, const gchar *capabilities, const gchar *language, const gchar *pw_warning, const char *address) |
| Add a user. More...
|
|
void | user_set_timezone (user_t *user, const gchar *timezone) |
| Set timezone of user. More...
|
|
void | user_set_username (user_t *user, const gchar *username) |
| Set username of user. More...
|
|
void | user_set_password (user_t *user, const gchar *password) |
| Set password of user. More...
|
|
void | user_set_language (user_t *user, const gchar *language) |
| Set language of user. More...
|
|
const gchar * | user_get_username (user_t *user) |
|
const gchar * | user_get_password (user_t *user) |
|
const gchar * | user_get_language (user_t *user) |
|
const gchar * | user_get_cookie (user_t *user) |
|
const gchar * | user_get_token (user_t *user) |
|
const gchar * | user_get_timezone (user_t *user) |
|
const gchar * | user_get_client_address (user_t *user) |
|
const gchar * | user_get_role (user_t *user) |
|
const gchar * | user_get_password_warning (user_t *user) |
|
const gchar * | user_get_capabilities (user_t *user) |
|
const time_t | user_get_session_timeout (user_t *user) |
|
int | user_logout (user_t *user) |
| Logout a user. More...
|
|
void | user_renew_session (user_t *user) |
|
◆ USER_BAD_MISSING_COOKIE
#define USER_BAD_MISSING_COOKIE 3 |
◆ USER_BAD_MISSING_TOKEN
#define USER_BAD_MISSING_TOKEN 4 |
◆ USER_BAD_TOKEN
◆ USER_EXPIRED_TOKEN
#define USER_EXPIRED_TOKEN 2 |
◆ USER_GMP_DOWN
◆ USER_IP_ADDRESS_MISSMATCH
#define USER_IP_ADDRESS_MISSMATCH 7 |
◆ USER_OK
◆ user_t
User information type, for sessions.
◆ user_add()
user_t* user_add |
( |
const gchar * |
username, |
|
|
const gchar * |
password, |
|
|
const gchar * |
timezone, |
|
|
const gchar * |
role, |
|
|
const gchar * |
capabilities, |
|
|
const gchar * |
language, |
|
|
const gchar * |
pw_warning, |
|
|
const char * |
address |
|
) |
| |
Add a user.
Creates and initializes a user object with given parameters
It's up to the caller to free the returned user.
- Parameters
-
[in] | username | Name of user. |
[in] | password | Password for user. |
[in] | timezone | Timezone of user. |
[in] | role | Role of user. |
[in] | capabilities | Capabilities of manager. |
[in] | language | User Interface Language (language name or code) |
[in] | pw_warning | Password policy warning. |
[in] | address | Client's IP address. |
- Returns
- Added user.
◆ user_copy()
◆ user_find()
int user_find |
( |
const gchar * |
cookie, |
|
|
const gchar * |
token, |
|
|
const char * |
address, |
|
|
user_t ** |
user_return |
|
) |
| |
Find a user, given a token and cookie.
If a user is returned, the session of the user is renewed and it's up to the caller to free the user.
- Parameters
-
[in] | cookie | Token in cookie. |
[in] | token | Token request parameter. |
[in] | address | Client's IP address. |
[out] | user_return | Copy of the User or NULL in error cases. |
- Returns
- 0 ok (user in user_return), 1 bad token, 2 expired token, 3 bad/missing cookie, 4 bad/missing token, 7 IP address mismatch,
◆ user_free()
void user_free |
( |
user_t * |
user | ) |
|
◆ user_get_capabilities()
const gchar* user_get_capabilities |
( |
user_t * |
user | ) |
|
◆ user_get_client_address()
const gchar* user_get_client_address |
( |
user_t * |
user | ) |
|
◆ user_get_cookie()
const gchar* user_get_cookie |
( |
user_t * |
user | ) |
|
◆ user_get_language()
const gchar* user_get_language |
( |
user_t * |
user | ) |
|
◆ user_get_password()
const gchar* user_get_password |
( |
user_t * |
user | ) |
|
◆ user_get_password_warning()
const gchar* user_get_password_warning |
( |
user_t * |
user | ) |
|
◆ user_get_role()
const gchar* user_get_role |
( |
user_t * |
user | ) |
|
◆ user_get_session_timeout()
const time_t user_get_session_timeout |
( |
user_t * |
user | ) |
|
◆ user_get_timezone()
const gchar* user_get_timezone |
( |
user_t * |
user | ) |
|
◆ user_get_token()
const gchar* user_get_token |
( |
user_t * |
user | ) |
|
◆ user_get_username()
const gchar* user_get_username |
( |
user_t * |
user | ) |
|
◆ user_logout()
int user_logout |
( |
user_t * |
user | ) |
|
Logout a user.
- Parameters
-
- Returns
- 0 success, -1 error.
◆ user_renew_session()
void user_renew_session |
( |
user_t * |
user | ) |
|
◆ user_set_language()
void user_set_language |
( |
user_t * |
user, |
|
|
const gchar * |
language |
|
) |
| |
Set language of user.
- Parameters
-
[in] | user | User. |
[in] | language | Language. |
◆ user_set_password()
void user_set_password |
( |
user_t * |
user, |
|
|
const gchar * |
password |
|
) |
| |
Set password of user.
- Parameters
-
[in] | user | User. |
[in] | password | Password. |
◆ user_set_timezone()
void user_set_timezone |
( |
user_t * |
user, |
|
|
const gchar * |
timezone |
|
) |
| |
Set timezone of user.
- Parameters
-
[in] | user | User. |
[in] | timezone | Timezone. |
◆ user_set_username()
void user_set_username |
( |
user_t * |
user, |
|
|
const gchar * |
username |
|
) |
| |
Set username of user.
- Parameters
-
[in] | user | User. |
[in] | username | Username. |