original/man2/add_key.2

   1 .\"
   2 .\" Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
   3 .\" Written by David Howells (dhowells@redhat.com)
   4 .\"
   5 .\" This program is free software; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License
   7 .\" as published by the Free Software Foundation; either version
   8 .\" 2 of the License, or (at your option) any later version.
   9 .\"
  10 .TH ADD_KEY 2 2010-02-25 Linux "Linux Key Management Calls"
  11 .SH NAME
  12 add_key \- Add a key to the kernel's key management facility
  13 .SH SYNOPSIS
  14 .nf
  15 .B #include <keyutils.h>
  16 .sp
  17 .BI "key_serial_t add_key(const char *" type ", const char *" description ,
  18 .BI "                     const void *" payload ", size_t " plen ,
  19 .BI "                     key_serial_t " keyring ");"
  20 .SH DESCRIPTION
  21 .BR add_key ()
  22 asks the kernel to create or update a key of the given
  23 .I type
  24 and
  25 .IR description ,
  26 instantiate it with the
  27 .I payload
  28 of length
  29 .IR plen ,
  30 and to attach it to the nominated
  31 .I keyring
  32 and to return its serial number.
  33 .P
  34 The key type may reject the data if it's in the wrong format or in some other
  35 way invalid.
  36 .P
  37 If the destination
  38 .I keyring
  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.
  44 .P
  45 The destination
  46 .I 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:
  49 .TP
  50 .B KEY_SPEC_THREAD_KEYRING
  51 This specifies the caller's thread-specific keyring.
  52 .TP
  53 .B KEY_SPEC_PROCESS_KEYRING
  54 This specifies the caller's process-specific keyring.
  55 .TP
  56 .B KEY_SPEC_SESSION_KEYRING
  57 This specifies the caller's session-specific keyring.
  58 .TP
  59 .B KEY_SPEC_USER_KEYRING
  60 This specifies the caller's UID-specific keyring.
  61 .TP
  62 .B KEY_SPEC_USER_SESSION_KEYRING
  63 This specifies the caller's UID-session keyring.
  64 .SH KEY TYPES
  65 There are a number of key types available in the core key management code, and
  66 these can be specified to this function:
  67 .TP
  68 .B \*(lquser\*(rq
  69 Keys of the user-defined key type may contain a blob of arbitrary data, and the
  70 .I description
  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).
  75 The
  76 .I payload
  77 may be empty or
  78 .B NULL
  79 for keys of this type.
  80 .TP
  81 .B \*(lqkeyring\*(rq
  82 Keyrings are special key types that may contain links to sequences of other
  83 keys of any type.  If this interface is used to create a keyring, then a
  84 .B NULL
  85 .I payload
  86 should be specified, and
  87 .I plen
  88 should be zero.
  89 .SH RETURN VALUE
  90 On success
  91 .BR add_key ()
  92 returns the serial number of the key it created or updated.
  93 On error, the value
  94 .B -1
  95 will be returned and errno will have been set to an appropriate error.
  96 .SH ERRORS
  97 .TP
  98 .B ENOKEY
  99 The keyring doesn't exist.
 100 .TP
 101 .B EKEYEXPIRED
 102 The keyring has expired.
 103 .TP
 104 .B EKEYREVOKED
 105 The keyring has been revoked.
 106 .TP
 107 .B EINVAL
 108 The payload data was invalid.
 109 .TP
 110 .B ENOMEM
 111 Insufficient memory to create a key.
 112 .TP
 113 .B EDQUOT
 114 The key quota for this user would be exceeded by creating this key or linking
 115 it to the keyring.
 116 .TP
 117 .B EACCES
 118 The keyring wasn't available for modification by the user.
 119 .SH LINKING
 120 Although this is a Linux system call, it is not present in
 121 .I libc
 122 but can be found rather in
 123 .IR libkeyutils .
 124 When linking,
 125 .B -lkeyutils
 126 should be specified to the linker.
 127 .SH SEE ALSO
 128 .BR keyctl (1),
 129 .BR keyctl (2),
 130 .BR request_key (2)