All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Macros | Functions
as_admin.h File Reference
#include <aerospike/aerospike.h>
#include <aerospike/as_config.h>
+ Include dependency graph for as_admin.h:

Go to the source code of this file.

Data Structures

struct  as_user_roles
 

Macros

#define AS_ROLE_SIZE   32
 

Functions

int aerospike_change_password (aerospike *as, const as_policy_admin *policy, const char *user, const char *password)
 
int aerospike_create_user (aerospike *as, const as_policy_admin *policy, const char *user, const char *password, const char **roles, int roles_size)
 
int aerospike_drop_user (aerospike *as, const as_policy_admin *policy, const char *user)
 
int aerospike_grant_roles (aerospike *as, const as_policy_admin *policy, const char *user, const char **roles, int roles_size)
 
int aerospike_query_user (aerospike *as, const as_policy_admin *policy, const char *user, as_user_roles **user_roles)
 
int aerospike_query_users (aerospike *as, const as_policy_admin *policy, as_user_roles ***user_roles, int *user_roles_size)
 
int aerospike_replace_roles (aerospike *as, const as_policy_admin *policy, const char *user, const char **roles, int roles_size)
 
int aerospike_revoke_roles (aerospike *as, const as_policy_admin *policy, const char *user, const char **roles, int roles_size)
 
int aerospike_set_password (aerospike *as, const as_policy_admin *policy, const char *user, const char *password)
 
int as_authenticate (int fd, const char *user, const char *credential, int timeout_ms)
 
void as_user_roles_destroy (as_user_roles *user_roles)
 
void as_user_roles_destroy_array (as_user_roles **user_roles, int user_roles_size)
 

Macro Definition Documentation

#define AS_ROLE_SIZE   32

Maximum size of role string including null byte.

Definition at line 29 of file as_admin.h.

Function Documentation

int aerospike_change_password ( aerospike as,
const as_policy_admin policy,
const char *  user,
const char *  password 
)

Change user's password by user. Clear-text password will be hashed using bcrypt before sending to server. Return zero on success.

int aerospike_create_user ( aerospike as,
const as_policy_admin policy,
const char *  user,
const char *  password,
const char **  roles,
int  roles_size 
)

Create user with password and roles. Clear-text password will be hashed using bcrypt before sending to server. Return zero on success.

int aerospike_drop_user ( aerospike as,
const as_policy_admin policy,
const char *  user 
)

Remove user from cluster. Return zero on success.

int aerospike_grant_roles ( aerospike as,
const as_policy_admin policy,
const char *  user,
const char **  roles,
int  roles_size 
)

Add role to user's list of roles. Return zero on success.

int aerospike_query_user ( aerospike as,
const as_policy_admin policy,
const char *  user,
as_user_roles **  user_roles 
)

Retrieve roles for a given user. Return zero on success. When successful, as_user_roles_destroy() must be called to free resources.

int aerospike_query_users ( aerospike as,
const as_policy_admin policy,
as_user_roles ***  user_roles,
int *  user_roles_size 
)

Retrieve all users and their roles. Return zero on success. When successful, as_user_roles_destroy_array() must be called to free resources.

int aerospike_replace_roles ( aerospike as,
const as_policy_admin policy,
const char *  user,
const char **  roles,
int  roles_size 
)

Replace user's list of roles with a new list of roles. Return zero on success.

int aerospike_revoke_roles ( aerospike as,
const as_policy_admin policy,
const char *  user,
const char **  roles,
int  roles_size 
)

Remove role from user's list of roles. Return zero on success.

int aerospike_set_password ( aerospike as,
const as_policy_admin policy,
const char *  user,
const char *  password 
)

Set user's password by user administrator. Clear-text password will be hashed using bcrypt before sending to server. Return zero on success.

int as_authenticate ( int  fd,
const char *  user,
const char *  credential,
int  timeout_ms 
)
private

Authenticate user with a server node. This is done automatically after socket open. Do not use this method directly.

void as_user_roles_destroy ( as_user_roles user_roles)

Release as_user_roles memory.

void as_user_roles_destroy_array ( as_user_roles **  user_roles,
int  user_roles_size 
)

Release memory for as_user_roles array.