auth

type AuthenticateRequestArg struct {
	Token []byte // the authentication token.
}

type AuthenticateResponseArg struct {
	Username     string    // the session related username;
	LastSeenTime time.Time // last connection from the user.
}

type Database interface {
	// db client related functions
	Copy() Database // retain the db client in a multi-coroutine environment;
	Close()         // release the client;
	// user behaviour
	GetUser(string) (*User, error) // gets a user struct from an argument username;
	SetUser(*User) error           // creates a new user in the db;
	RemoveUser(string) error       // remove an user from the db;
	// session behaviour
	GetSession([]byte) (*Session, error) // search for a session in the db;
	SetSession(*Session) error           // insert a session in the db;
	RemoveSession([]byte) error          // remove an existing session;
	RemoveAllSessions() error            // remove all sessions in the db.
}

type DbArgs struct {
	Addresses []string // cluster addresses in form <addr>:<port>;
	User      string   // authentication username;
	Password  string   // authentication password;
	AuthDb    string   // the auth db.
}

type Level uint

type Login int

type LoginRequestArg struct {
	Username string // the authenticating username;
	Password string // plaintext password.
}

type LoginResponseArg struct {
	Token []byte // the session token to be used, from now on, to communicate with server.
}

type LogoutRequestArg struct {
	Token []byte // the session token used to identify the user.
}

type LogoutResponseArg struct {
	Invalidated []byte
}

type Mongodb struct {
	// contains filtered or unexported fields
}

type Permissions struct {
	SuperAdmin bool             `bson:"superadmin,omitempty"` // special user that have all permissions on all services;
	Services   map[string]Level `bson:"services"`             // permissions organised per service, the "all" can be used for generalised behaviour.
}

type RemoveUserRequestArg struct {
	Token    []byte // the authentication token;
	Username string // the user to be removed.
}

type Session struct {
	Token        []byte        `bson:"token"`       // token for the session;
	Username     string        `bson:"username"`    // username associated to session;
	LoginTime    time.Time     `bson:"login_ts"`    // timestamp of login time for this session;
	LastSeenTime time.Time     `bson:"lastseen_ts"` // last call to an API done by the user;
	TimeToLive   time.Duration `bson:"timetolive"`  // time of validity of the session.
}

type SessionAuth int

type UpserUserRequestArg struct {
	Token []byte // the authentication token;
	User  User   // the user record to be updated.
}

type User struct {
	Username       string      `bson:"username"`           // user name;
	FullName       string      `bson:"fullname,omitempty"` // complete full name;
	HashedPassword []byte      `bson:"pwdhash"`            // hashed password;
	Email          string      `bson:"email,omitempty"`    // user's verified email;
	Permissions    Permissions `bson:"permissions"`        // the permissions associated to the user;
	IsDisabled     bool        `bson:"disabled"`           // user active (true) or not (false).
}

type UserInfoResponseArg struct {
	Username    string       // the session related username;
	FullName    string       // the user full name;
	Email       string       // the user email address;
	Permissions *Permissions // user associated permissions;
	LastSeen    time.Time    // last seen info.
}

type VoidResponseArg struct{}