06afbd14eb
The admin users now have a concept of write and read permissions. This allows restricted read-only access to be granted to users.
164 lines
3.5 KiB
C
164 lines
3.5 KiB
C
#pragma once
|
|
/*
|
|
* Copyright (c) 2016 MariaDB Corporation Ab
|
|
*
|
|
* Use of this software is governed by the Business Source License included
|
|
* in the LICENSE.TXT file and at www.mariadb.com/bsl11.
|
|
*
|
|
* Change Date: 2020-01-01
|
|
*
|
|
* On the date above, in accordance with the Business Source License, use
|
|
* of this software will be governed by version 2 or later of the General
|
|
* Public License.
|
|
*/
|
|
|
|
/**
|
|
* @file users.h The functions to manipulate a set of administrative users
|
|
*/
|
|
|
|
#include <maxscale/cdefs.h>
|
|
#include <maxscale/hashtable.h>
|
|
#include <maxscale/dcb.h>
|
|
#include <maxscale/listener.h>
|
|
#include <maxscale/service.h>
|
|
#include <openssl/sha.h>
|
|
|
|
MXS_BEGIN_DECLS
|
|
|
|
/**
|
|
* An opaque users object
|
|
*/
|
|
typedef struct users
|
|
{
|
|
} USERS;
|
|
|
|
/**
|
|
* Allocate a new users table
|
|
*
|
|
* @return The users table or NULL if memory allocation failed
|
|
*/
|
|
USERS* users_alloc();
|
|
|
|
/**
|
|
* Free a users table
|
|
*
|
|
* @param users Users table to free
|
|
*/
|
|
void users_free(USERS* users);
|
|
|
|
/**
|
|
* Add a new user to the user table. The user name must be unique
|
|
*
|
|
* @param users The users table
|
|
* @param user The user name
|
|
* @param password The password for the user
|
|
*
|
|
* @return True if user was added
|
|
*/
|
|
bool users_add(USERS *users, const char *user, const char *password);
|
|
|
|
/**
|
|
* Delete a user from the user table.
|
|
*
|
|
* @param users The users table
|
|
* @param user The user name
|
|
*
|
|
* @return True if user was deleted
|
|
*/
|
|
bool users_delete(USERS *users, const char *user);
|
|
|
|
/**
|
|
* Authenticate a user
|
|
*
|
|
* @param users The users table
|
|
* @param user The user name
|
|
* @param pw The password sent by the user
|
|
*
|
|
* @return True if authentication data matched the stored value
|
|
*/
|
|
bool users_auth(USERS* users, const char* user, const char* password);
|
|
|
|
/**
|
|
* Check if a user exists
|
|
*
|
|
* @param users The users table
|
|
* @param user User to find
|
|
*
|
|
* @return True if user exists
|
|
*/
|
|
bool users_find(USERS* users, const char* user);
|
|
|
|
/**
|
|
* Check if user is an administrator
|
|
*
|
|
* @param users The users table
|
|
* @param user User to check
|
|
*
|
|
* @return True if user is an administrator
|
|
*/
|
|
bool users_is_admin(USERS* users, const char* user);
|
|
|
|
/**
|
|
* Promote a user to an administrator
|
|
*
|
|
* @param users The users table
|
|
* @param user User to promote
|
|
*
|
|
* @return True if user was found and promoted
|
|
*/
|
|
bool users_promote(USERS* users, const char* user);
|
|
|
|
/**
|
|
* Demote an administrative user to a normal user
|
|
*
|
|
* @param users The users table
|
|
* @param user User to demote
|
|
*
|
|
* @return True if user was found and demoted
|
|
*/
|
|
bool users_demote(USERS* users, const char* user);
|
|
|
|
/**
|
|
* @brief Default user loading function
|
|
*
|
|
* A generic key-value user table is allocated for the service.
|
|
*
|
|
* @param port Listener configuration
|
|
* @return Always AUTH_LOADUSERS_OK
|
|
*/
|
|
int users_default_loadusers(SERV_LISTENER *port);
|
|
|
|
/**
|
|
* @brief Default authenticator diagnostic function
|
|
*
|
|
* @param dcb DCB where data is printed
|
|
* @param port Port whose data is to be printed
|
|
*/
|
|
void users_default_diagnostic(DCB *dcb, SERV_LISTENER *port);
|
|
|
|
/**
|
|
* @brief Default authenticator diagnostic function
|
|
*
|
|
* @param port Port whose data is to be printed
|
|
*/
|
|
json_t* users_default_diagnostic_json(const SERV_LISTENER *port);
|
|
|
|
/**
|
|
* Print users to a DCB
|
|
*
|
|
* @param dcb DCB where users are printed
|
|
* @param users Users to print
|
|
*/
|
|
void users_diagnostic(DCB* dcb, USERS* users);
|
|
|
|
/**
|
|
* Convert users to JSON
|
|
*
|
|
* @param users Users to convert
|
|
*
|
|
* @return JSON version of users
|
|
*/
|
|
json_t* users_diagnostic_json(USERS* users);
|
|
|
|
MXS_END_DECLS
|