Module riak_core_security

Data Types

bucket()

bucket() = {binary(), binary()} | binary()

context()

context() = #context{}

metadata_key()

metadata_key() = string()

metadata_value()

metadata_value() = term()

options()

options() = [{metadata_key(), metadata_value()}]

permission()

permission() = {string()} | {string(), bucket()}

userlist()

userlist() = all | [string()]

Function Index

add_grant/3
add_group/2
add_revoke/3
add_source/4
add_user/2
alter_group/2
alter_user/2
authenticate/3
check_permission/2
check_permissions/2
del_group/1
del_source/2
del_user/1
disable/0
enable/0
find_bucket_grants/2
find_one_user_by_metadata/2
find_unique_user_by_metadata/2
find_user/1
get_ciphers/0
get_username/1
is_enabled/0
print_ciphers/0
print_grants/1
print_group/1
print_groups/0
print_sources/0
print_user/1
print_users/0
set_ciphers/1
status/0

Function Details

add_grant/3

add_grant(RoleList::userlist(), Bucket::bucket() | any, Grants::[string()]) -> ok | {error, term()}

add_group/2

add_group(Groupname::string(), Options::options()) -> ok | {error, term()}

add_revoke/3

add_revoke(RoleList::userlist(), Bucket::bucket() | any, Revokes::[string()]) -> ok | {error, term()}

add_source/4

add_source(Users::userlist(), CIDR::{inet:ip_address(), non_neg_integer()}, Source::atom(), Options::options()) -> ok | {error, term()}

add_user/2

add_user(Username::string(), Options::options()) -> ok | {error, term()}

alter_group/2

alter_group(Groupname::string(), Options::options()) -> ok | {error, term()}

alter_user/2

alter_user(Username::string(), Options::options()) -> ok | {error, term()}

authenticate/3

authenticate(Username::binary(), Password::binary(), ConnInfo::[{atom(), any()}]) -> {ok, context()} | {error, term()}

check_permission/2

check_permission(Permission::permission(), Context::context()) -> {true, context()} | {false, binary(), context()}

check_permissions/2

check_permissions(Permission, Ctx) -> any()

del_group/1

del_group(Groupname::string()) -> ok | {error, term()}

del_source/2

del_source(Users, CIDR) -> any()

del_user/1

del_user(Username::string()) -> ok | {error, term()}

disable/0

disable() -> any()

enable/0

enable() -> any()

find_bucket_grants/2

find_bucket_grants(Bucket::bucket(), Type::user | group) -> [{RoleName::string(), [permission()]}]

find_one_user_by_metadata/2

find_one_user_by_metadata(Key::metadata_key(), Value::metadata_value()) -> {Username::string(), options()} | {error, not_found}

find_unique_user_by_metadata/2

find_unique_user_by_metadata(Key::metadata_key(), Value::metadata_value()) -> {Username::string(), options()} | {error, not_found | not_unique}

find_user/1

find_user(Username::string()) -> options() | {error, not_found}

get_ciphers/0

get_ciphers() -> any()

get_username/1

get_username(Context) -> any()

is_enabled/0

is_enabled() -> any()

print_ciphers/0

print_ciphers() -> any()

print_grants/1

print_grants(Rolename::string()) -> ok | {error, term()}

print_group/1

print_group(Group::string()) -> ok | {error, term()}

print_groups/0

print_groups() -> any()

print_sources/0

print_sources() -> any()

print_user/1

print_user(Username::string()) -> ok | {error, term()}

print_users/0

print_users() -> any()

set_ciphers/1

set_ciphers(CipherList) -> any()

status/0

status() -> any()


Generated by EDoc