Module lockchain_core::users[][src]

User and access regulation module

Access can be given for a vault or file (based on id) as well as an entire Api endpoint. By default all Rust APIs assume { Api, Admin } access, for other APIs crates (http, ...), a user with access rights has to be specified.

A user for an API endpoint is not the same as a user for a vault. An API admin could have access to a vault where they can only read a single file!

User is also a serialisable struct which contains important data to load and store them into a metadata store.

Structs

Token

An authentication token that can be compared in constant time

User

A generic user representation

UserStore

A utility structure that manages users and can be derived from/into a metadata object. By default this process uses base64 encoding.

Enums

Access

Specifies access to a resource

AuthError

Common errors that can occur when authenticating users

Role

Specifies the capabilities of a user

Functions

pam_authenticate

Simple way to authenticate a user for administrative actions