find_key_by_type_and_name (3)

Leading comments

Copyright (C) 2013 Red Hat, Inc. All Rights Reserved.
Written by David Howells (dhowells@redhat.com)

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public Licence
as published by the Free Software Foundation; either version
2 of the Licence, or (at your option) any later version.

(The comments found at the beginning of the groff file "man3/find_key_by_type_and_name.3".)

NAME

find_key_by_type_and_name - Find a key by type and name

SYNOPSIS

#include <keyutils.h>

key_serial_t find_key_by_type_and_name(const char *type,
    const char *description, key_serial_t destringid);

DESCRIPTION

find_key_by_type_and_name() searches for a key with the given type and exact description, firstly in the thread, process and session keyrings to which a process is subscribed and secondly in /proc/keys. If a key is found, and destringid is not 0 and specifies a keyring, then the found key will be linked into it.

RETURN VALUE

The function returns the ID of the key if a key was found or -1 otherwise.

ERRORS

ENOKEY

No key was found or the keyring specified is invalid.

EKEYEXPIRED

The key or keyring have expired.

EKEYREVOKED

The key or keyring have been revoked.

EACCES

The key is not accessible or keyring exists, but is not writable by the calling process.

LINKING

When linking, -lkeyutils should be specified to the linker.

SEE ALSO

keyctl(3), request_key(3)