linux man page for keyctl_join_session_keyring

KEYCTL_JOIN_SESSION_KEYRING(3)                              Linux Key Management Calls                              KEYCTL_JOIN_SESSION_KEYRING(3)

NAME
       keyctl_join_session_keyring - Join a different session keyring

SYNOPSIS
       #include <keyutils.h>

       key_serial_t keyctl_join_session_keyring(const char *name);

DESCRIPTION
       keyctl_join_session_keyring() changes the session keyring to which a process is subscribed.

       If name is NULL then a new anonymous keyring will be created, and the process will be subscribed to that.

       If  name  points to a string, then if a keyring of that name is available, the process will attempt to subscribe to that keyring, giving an
       error if that is not permitted; otherwise a new keyring of that name is created and attached as the session keyring.

       To attach to an extant named keyring, the keyring must have search permission available to the calling process.

RETURN VALUE
       On success keyctl_join_session_keyring() returns the serial number of the key it found or created.  On error, the value -1 will be returned
       and errno will have been set to an appropriate error.

ERRORS
       ENOMEM Insufficient memory to create a key.

       EDQUOT The key quota for this user would be exceeded by creating this key or linking it to the keyring.

       EACCES The named keyring exists, but is not searchable by the calling process.

LINKING
       This is a library function that can be found in libkeyutils.  When linking, -lkeyutils should be specified to the linker.

SEE ALSO
       keyctl(1),
       add_key(2),
       keyctl(2),
       request_key(2),
       keyctl_get_keyring_ID(3),
       keyctl_update(3),
       keyctl_revoke(3),
       keyctl_chown(3),
       keyctl_setperm(3),
       keyctl_describe(3),
       keyctl_clear(3),
       keyctl_link(3),
       keyctl_unlink(3),
       keyctl_search(3),
       keyctl_read(3),
       keyctl_instantiate(3),
       keyctl_negate(3),
       keyctl_set_reqkey_keyring(3),
       keyctl_set_timeout(3),
       keyctl_assume_authority(3),
       keyctl_describe_alloc(3),
       keyctl_read_alloc(3),
       request-key(8)

Linux                                                               4 May 2006                                      KEYCTL_JOIN_SESSION_KEYRING(3)