1 .\" Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
2 .\" Written by David Howells (dhowells@redhat.com)
4 .\" This program is free software; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License
6 .\" as published by the Free Software Foundation; either version
7 .\" 2 of the License, or (at your option) any later version.
9 .TH ADD_KEY 2 2010-02-25 Linux "Linux Key Management Calls"
11 add_key \- add a key to the kernel's key management facility
14 .B #include <keyutils.h>
16 .BI "key_serial_t add_key(const char *" type ", const char *" description ,
17 .BI " const void *" payload ", size_t " plen ,
18 .BI " key_serial_t " keyring ");"
22 asks the kernel to create or update a key of the given
26 instantiate it with the
30 and to attach it to the nominated
32 and to return its serial number.
34 The key type may reject the data if it's in the wrong format or in some other
39 already contains a key that matches the specified
40 .IR type " and " description
41 then, if the key type supports it, that key will be updated rather than a new
42 key being created; if not, a new key will be created and it will displace the
43 link to the extant key from the keyring.
47 serial number may be that of a valid keyring to which the caller has write
48 permission, or it may be a special keyring ID:
50 .B KEY_SPEC_THREAD_KEYRING
51 This specifies the caller's thread-specific keyring.
53 .B KEY_SPEC_PROCESS_KEYRING
54 This specifies the caller's process-specific keyring.
56 .B KEY_SPEC_SESSION_KEYRING
57 This specifies the caller's session-specific keyring.
59 .B KEY_SPEC_USER_KEYRING
60 This specifies the caller's UID-specific keyring.
62 .B KEY_SPEC_USER_SESSION_KEYRING
63 This specifies the caller's UID-session keyring.
65 There are a number of key types available in the core key management code, and
66 these can be specified to this function:
69 Keys of the user-defined key type may contain a blob of arbitrary data, and the
71 may be any valid string, though it is preferred that the description be
72 prefixed with a string representing the service to which the key is of interest
73 and a colon (for instance
74 .RB \*(lq afs:mykey \*(rq).
77 may be empty or NULL for keys of this type.
80 Keyrings are special key types that may contain links to sequences of other
82 If this interface is used to create a keyring, then a NULL
84 should be specified, and
90 returns the serial number of the key it created or updated.
91 On error, the value \-1
92 will be returned and errno will have been set to an appropriate error.
96 The keyring doesn't exist.
99 The keyring has expired.
102 The keyring has been revoked.
105 The payload data was invalid.
108 Insufficient memory to create a key.
111 The key quota for this user would be exceeded by creating this key or linking
115 The keyring wasn't available for modification by the user.
117 Although this is a Linux system call, it is not present in
119 but can be found rather in
123 should be specified to the linker.