Merge tag 'clk-bulk-get-prep-enable' of git://git.kernel.org/pub/scm/linux/kernel...
[muen/linux.git] / Documentation / security / keys / core.rst
1 ============================
2 Kernel Key Retention Service
3 ============================
4
5 This service allows cryptographic keys, authentication tokens, cross-domain
6 user mappings, and similar to be cached in the kernel for the use of
7 filesystems and other kernel services.
8
9 Keyrings are permitted; these are a special type of key that can hold links to
10 other keys. Processes each have three standard keyring subscriptions that a
11 kernel service can search for relevant keys.
12
13 The key service can be configured on by enabling:
14
15         "Security options"/"Enable access key retention support" (CONFIG_KEYS)
16
17 This document has the following sections:
18
19         - Key overview
20         - Key service overview
21         - Key access permissions
22         - SELinux support
23         - New procfs files
24         - Userspace system call interface
25         - Kernel services
26         - Notes on accessing payload contents
27         - Defining a key type
28         - Request-key callback service
29         - Garbage collection
30
31
32 Key Overview
33 ============
34
35 In this context, keys represent units of cryptographic data, authentication
36 tokens, keyrings, etc.. These are represented in the kernel by struct key.
37
38 Each key has a number of attributes:
39
40         - A serial number.
41         - A type.
42         - A description (for matching a key in a search).
43         - Access control information.
44         - An expiry time.
45         - A payload.
46         - State.
47
48
49   *  Each key is issued a serial number of type key_serial_t that is unique for
50      the lifetime of that key. All serial numbers are positive non-zero 32-bit
51      integers.
52
53      Userspace programs can use a key's serial numbers as a way to gain access
54      to it, subject to permission checking.
55
56   *  Each key is of a defined "type". Types must be registered inside the
57      kernel by a kernel service (such as a filesystem) before keys of that type
58      can be added or used. Userspace programs cannot define new types directly.
59
60      Key types are represented in the kernel by struct key_type. This defines a
61      number of operations that can be performed on a key of that type.
62
63      Should a type be removed from the system, all the keys of that type will
64      be invalidated.
65
66   *  Each key has a description. This should be a printable string. The key
67      type provides an operation to perform a match between the description on a
68      key and a criterion string.
69
70   *  Each key has an owner user ID, a group ID and a permissions mask. These
71      are used to control what a process may do to a key from userspace, and
72      whether a kernel service will be able to find the key.
73
74   *  Each key can be set to expire at a specific time by the key type's
75      instantiation function. Keys can also be immortal.
76
77   *  Each key can have a payload. This is a quantity of data that represent the
78      actual "key". In the case of a keyring, this is a list of keys to which
79      the keyring links; in the case of a user-defined key, it's an arbitrary
80      blob of data.
81
82      Having a payload is not required; and the payload can, in fact, just be a
83      value stored in the struct key itself.
84
85      When a key is instantiated, the key type's instantiation function is
86      called with a blob of data, and that then creates the key's payload in
87      some way.
88
89      Similarly, when userspace wants to read back the contents of the key, if
90      permitted, another key type operation will be called to convert the key's
91      attached payload back into a blob of data.
92
93   *  Each key can be in one of a number of basic states:
94
95       *  Uninstantiated. The key exists, but does not have any data attached.
96          Keys being requested from userspace will be in this state.
97
98       *  Instantiated. This is the normal state. The key is fully formed, and
99          has data attached.
100
101       *  Negative. This is a relatively short-lived state. The key acts as a
102          note saying that a previous call out to userspace failed, and acts as
103          a throttle on key lookups. A negative key can be updated to a normal
104          state.
105
106       *  Expired. Keys can have lifetimes set. If their lifetime is exceeded,
107          they traverse to this state. An expired key can be updated back to a
108          normal state.
109
110       *  Revoked. A key is put in this state by userspace action. It can't be
111          found or operated upon (apart from by unlinking it).
112
113       *  Dead. The key's type was unregistered, and so the key is now useless.
114
115 Keys in the last three states are subject to garbage collection.  See the
116 section on "Garbage collection".
117
118
119 Key Service Overview
120 ====================
121
122 The key service provides a number of features besides keys:
123
124   *  The key service defines three special key types:
125
126      (+) "keyring"
127
128          Keyrings are special keys that contain a list of other keys. Keyring
129          lists can be modified using various system calls. Keyrings should not
130          be given a payload when created.
131
132      (+) "user"
133
134          A key of this type has a description and a payload that are arbitrary
135          blobs of data. These can be created, updated and read by userspace,
136          and aren't intended for use by kernel services.
137
138      (+) "logon"
139
140          Like a "user" key, a "logon" key has a payload that is an arbitrary
141          blob of data. It is intended as a place to store secrets which are
142          accessible to the kernel but not to userspace programs.
143
144          The description can be arbitrary, but must be prefixed with a non-zero
145          length string that describes the key "subclass". The subclass is
146          separated from the rest of the description by a ':'. "logon" keys can
147          be created and updated from userspace, but the payload is only
148          readable from kernel space.
149
150   *  Each process subscribes to three keyrings: a thread-specific keyring, a
151      process-specific keyring, and a session-specific keyring.
152
153      The thread-specific keyring is discarded from the child when any sort of
154      clone, fork, vfork or execve occurs. A new keyring is created only when
155      required.
156
157      The process-specific keyring is replaced with an empty one in the child on
158      clone, fork, vfork unless CLONE_THREAD is supplied, in which case it is
159      shared. execve also discards the process's process keyring and creates a
160      new one.
161
162      The session-specific keyring is persistent across clone, fork, vfork and
163      execve, even when the latter executes a set-UID or set-GID binary. A
164      process can, however, replace its current session keyring with a new one
165      by using PR_JOIN_SESSION_KEYRING. It is permitted to request an anonymous
166      new one, or to attempt to create or join one of a specific name.
167
168      The ownership of the thread keyring changes when the real UID and GID of
169      the thread changes.
170
171   *  Each user ID resident in the system holds two special keyrings: a user
172      specific keyring and a default user session keyring. The default session
173      keyring is initialised with a link to the user-specific keyring.
174
175      When a process changes its real UID, if it used to have no session key, it
176      will be subscribed to the default session key for the new UID.
177
178      If a process attempts to access its session key when it doesn't have one,
179      it will be subscribed to the default for its current UID.
180
181   *  Each user has two quotas against which the keys they own are tracked. One
182      limits the total number of keys and keyrings, the other limits the total
183      amount of description and payload space that can be consumed.
184
185      The user can view information on this and other statistics through procfs
186      files.  The root user may also alter the quota limits through sysctl files
187      (see the section "New procfs files").
188
189      Process-specific and thread-specific keyrings are not counted towards a
190      user's quota.
191
192      If a system call that modifies a key or keyring in some way would put the
193      user over quota, the operation is refused and error EDQUOT is returned.
194
195   *  There's a system call interface by which userspace programs can create and
196      manipulate keys and keyrings.
197
198   *  There's a kernel interface by which services can register types and search
199      for keys.
200
201   *  There's a way for the a search done from the kernel to call back to
202      userspace to request a key that can't be found in a process's keyrings.
203
204   *  An optional filesystem is available through which the key database can be
205      viewed and manipulated.
206
207
208 Key Access Permissions
209 ======================
210
211 Keys have an owner user ID, a group access ID, and a permissions mask. The mask
212 has up to eight bits each for possessor, user, group and other access. Only
213 six of each set of eight bits are defined. These permissions granted are:
214
215   *  View
216
217      This permits a key or keyring's attributes to be viewed - including key
218      type and description.
219
220   *  Read
221
222      This permits a key's payload to be viewed or a keyring's list of linked
223      keys.
224
225   *  Write
226
227      This permits a key's payload to be instantiated or updated, or it allows a
228      link to be added to or removed from a keyring.
229
230   *  Search
231
232      This permits keyrings to be searched and keys to be found. Searches can
233      only recurse into nested keyrings that have search permission set.
234
235   *  Link
236
237      This permits a key or keyring to be linked to. To create a link from a
238      keyring to a key, a process must have Write permission on the keyring and
239      Link permission on the key.
240
241   *  Set Attribute
242
243      This permits a key's UID, GID and permissions mask to be changed.
244
245 For changing the ownership, group ID or permissions mask, being the owner of
246 the key or having the sysadmin capability is sufficient.
247
248
249 SELinux Support
250 ===============
251
252 The security class "key" has been added to SELinux so that mandatory access
253 controls can be applied to keys created within various contexts.  This support
254 is preliminary, and is likely to change quite significantly in the near future.
255 Currently, all of the basic permissions explained above are provided in SELinux
256 as well; SELinux is simply invoked after all basic permission checks have been
257 performed.
258
259 The value of the file /proc/self/attr/keycreate influences the labeling of
260 newly-created keys.  If the contents of that file correspond to an SELinux
261 security context, then the key will be assigned that context.  Otherwise, the
262 key will be assigned the current context of the task that invoked the key
263 creation request.  Tasks must be granted explicit permission to assign a
264 particular context to newly-created keys, using the "create" permission in the
265 key security class.
266
267 The default keyrings associated with users will be labeled with the default
268 context of the user if and only if the login programs have been instrumented to
269 properly initialize keycreate during the login process.  Otherwise, they will
270 be labeled with the context of the login program itself.
271
272 Note, however, that the default keyrings associated with the root user are
273 labeled with the default kernel context, since they are created early in the
274 boot process, before root has a chance to log in.
275
276 The keyrings associated with new threads are each labeled with the context of
277 their associated thread, and both session and process keyrings are handled
278 similarly.
279
280
281 New ProcFS Files
282 ================
283
284 Two files have been added to procfs by which an administrator can find out
285 about the status of the key service:
286
287   *  /proc/keys
288
289      This lists the keys that are currently viewable by the task reading the
290      file, giving information about their type, description and permissions.
291      It is not possible to view the payload of the key this way, though some
292      information about it may be given.
293
294      The only keys included in the list are those that grant View permission to
295      the reading process whether or not it possesses them.  Note that LSM
296      security checks are still performed, and may further filter out keys that
297      the current process is not authorised to view.
298
299      The contents of the file look like this::
300
301         SERIAL   FLAGS  USAGE EXPY PERM     UID   GID   TYPE      DESCRIPTION: SUMMARY
302         00000001 I-----    39 perm 1f3f0000     0     0 keyring   _uid_ses.0: 1/4
303         00000002 I-----     2 perm 1f3f0000     0     0 keyring   _uid.0: empty
304         00000007 I-----     1 perm 1f3f0000     0     0 keyring   _pid.1: empty
305         0000018d I-----     1 perm 1f3f0000     0     0 keyring   _pid.412: empty
306         000004d2 I--Q--     1 perm 1f3f0000    32    -1 keyring   _uid.32: 1/4
307         000004d3 I--Q--     3 perm 1f3f0000    32    -1 keyring   _uid_ses.32: empty
308         00000892 I--QU-     1 perm 1f000000     0     0 user      metal:copper: 0
309         00000893 I--Q-N     1  35s 1f3f0000     0     0 user      metal:silver: 0
310         00000894 I--Q--     1  10h 003f0000     0     0 user      metal:gold: 0
311
312      The flags are::
313
314         I       Instantiated
315         R       Revoked
316         D       Dead
317         Q       Contributes to user's quota
318         U       Under construction by callback to userspace
319         N       Negative key
320
321
322   *  /proc/key-users
323
324      This file lists the tracking data for each user that has at least one key
325      on the system.  Such data includes quota information and statistics::
326
327         [root@andromeda root]# cat /proc/key-users
328         0:     46 45/45 1/100 13/10000
329         29:     2 2/2 2/100 40/10000
330         32:     2 2/2 2/100 40/10000
331         38:     2 2/2 2/100 40/10000
332
333      The format of each line is::
334
335         <UID>:                  User ID to which this applies
336         <usage>                 Structure refcount
337         <inst>/<keys>           Total number of keys and number instantiated
338         <keys>/<max>            Key count quota
339         <bytes>/<max>           Key size quota
340
341
342 Four new sysctl files have been added also for the purpose of controlling the
343 quota limits on keys:
344
345   *  /proc/sys/kernel/keys/root_maxkeys
346      /proc/sys/kernel/keys/root_maxbytes
347
348      These files hold the maximum number of keys that root may have and the
349      maximum total number of bytes of data that root may have stored in those
350      keys.
351
352   *  /proc/sys/kernel/keys/maxkeys
353      /proc/sys/kernel/keys/maxbytes
354
355      These files hold the maximum number of keys that each non-root user may
356      have and the maximum total number of bytes of data that each of those
357      users may have stored in their keys.
358
359 Root may alter these by writing each new limit as a decimal number string to
360 the appropriate file.
361
362
363 Userspace System Call Interface
364 ===============================
365
366 Userspace can manipulate keys directly through three new syscalls: add_key,
367 request_key and keyctl. The latter provides a number of functions for
368 manipulating keys.
369
370 When referring to a key directly, userspace programs should use the key's
371 serial number (a positive 32-bit integer). However, there are some special
372 values available for referring to special keys and keyrings that relate to the
373 process making the call::
374
375         CONSTANT                        VALUE   KEY REFERENCED
376         ==============================  ======  ===========================
377         KEY_SPEC_THREAD_KEYRING         -1      thread-specific keyring
378         KEY_SPEC_PROCESS_KEYRING        -2      process-specific keyring
379         KEY_SPEC_SESSION_KEYRING        -3      session-specific keyring
380         KEY_SPEC_USER_KEYRING           -4      UID-specific keyring
381         KEY_SPEC_USER_SESSION_KEYRING   -5      UID-session keyring
382         KEY_SPEC_GROUP_KEYRING          -6      GID-specific keyring
383         KEY_SPEC_REQKEY_AUTH_KEY        -7      assumed request_key()
384                                                   authorisation key
385
386
387 The main syscalls are:
388
389   *  Create a new key of given type, description and payload and add it to the
390      nominated keyring::
391
392         key_serial_t add_key(const char *type, const char *desc,
393                              const void *payload, size_t plen,
394                              key_serial_t keyring);
395
396      If a key of the same type and description as that proposed already exists
397      in the keyring, this will try to update it with the given payload, or it
398      will return error EEXIST if that function is not supported by the key
399      type. The process must also have permission to write to the key to be able
400      to update it. The new key will have all user permissions granted and no
401      group or third party permissions.
402
403      Otherwise, this will attempt to create a new key of the specified type and
404      description, and to instantiate it with the supplied payload and attach it
405      to the keyring. In this case, an error will be generated if the process
406      does not have permission to write to the keyring.
407
408      If the key type supports it, if the description is NULL or an empty
409      string, the key type will try and generate a description from the content
410      of the payload.
411
412      The payload is optional, and the pointer can be NULL if not required by
413      the type. The payload is plen in size, and plen can be zero for an empty
414      payload.
415
416      A new keyring can be generated by setting type "keyring", the keyring name
417      as the description (or NULL) and setting the payload to NULL.
418
419      User defined keys can be created by specifying type "user". It is
420      recommended that a user defined key's description by prefixed with a type
421      ID and a colon, such as "krb5tgt:" for a Kerberos 5 ticket granting
422      ticket.
423
424      Any other type must have been registered with the kernel in advance by a
425      kernel service such as a filesystem.
426
427      The ID of the new or updated key is returned if successful.
428
429
430   *  Search the process's keyrings for a key, potentially calling out to
431      userspace to create it::
432
433         key_serial_t request_key(const char *type, const char *description,
434                                  const char *callout_info,
435                                  key_serial_t dest_keyring);
436
437      This function searches all the process's keyrings in the order thread,
438      process, session for a matching key. This works very much like
439      KEYCTL_SEARCH, including the optional attachment of the discovered key to
440      a keyring.
441
442      If a key cannot be found, and if callout_info is not NULL, then
443      /sbin/request-key will be invoked in an attempt to obtain a key. The
444      callout_info string will be passed as an argument to the program.
445
446      See also Documentation/security/keys-request-key.txt.
447
448
449 The keyctl syscall functions are:
450
451   *  Map a special key ID to a real key ID for this process::
452
453         key_serial_t keyctl(KEYCTL_GET_KEYRING_ID, key_serial_t id,
454                             int create);
455
456      The special key specified by "id" is looked up (with the key being created
457      if necessary) and the ID of the key or keyring thus found is returned if
458      it exists.
459
460      If the key does not yet exist, the key will be created if "create" is
461      non-zero; and the error ENOKEY will be returned if "create" is zero.
462
463
464   *  Replace the session keyring this process subscribes to with a new one::
465
466         key_serial_t keyctl(KEYCTL_JOIN_SESSION_KEYRING, const char *name);
467
468      If name is NULL, an anonymous keyring is created attached to the process
469      as its session keyring, displacing the old session keyring.
470
471      If name is not NULL, if a keyring of that name exists, the process
472      attempts to attach it as the session keyring, returning an error if that
473      is not permitted; otherwise a new keyring of that name is created and
474      attached as the session keyring.
475
476      To attach to a named keyring, the keyring must have search permission for
477      the process's ownership.
478
479      The ID of the new session keyring is returned if successful.
480
481
482   *  Update the specified key::
483
484         long keyctl(KEYCTL_UPDATE, key_serial_t key, const void *payload,
485                     size_t plen);
486
487      This will try to update the specified key with the given payload, or it
488      will return error EOPNOTSUPP if that function is not supported by the key
489      type. The process must also have permission to write to the key to be able
490      to update it.
491
492      The payload is of length plen, and may be absent or empty as for
493      add_key().
494
495
496   *  Revoke a key::
497
498         long keyctl(KEYCTL_REVOKE, key_serial_t key);
499
500      This makes a key unavailable for further operations. Further attempts to
501      use the key will be met with error EKEYREVOKED, and the key will no longer
502      be findable.
503
504
505   *  Change the ownership of a key::
506
507         long keyctl(KEYCTL_CHOWN, key_serial_t key, uid_t uid, gid_t gid);
508
509      This function permits a key's owner and group ID to be changed. Either one
510      of uid or gid can be set to -1 to suppress that change.
511
512      Only the superuser can change a key's owner to something other than the
513      key's current owner. Similarly, only the superuser can change a key's
514      group ID to something other than the calling process's group ID or one of
515      its group list members.
516
517
518   *  Change the permissions mask on a key::
519
520         long keyctl(KEYCTL_SETPERM, key_serial_t key, key_perm_t perm);
521
522      This function permits the owner of a key or the superuser to change the
523      permissions mask on a key.
524
525      Only bits the available bits are permitted; if any other bits are set,
526      error EINVAL will be returned.
527
528
529   *  Describe a key::
530
531         long keyctl(KEYCTL_DESCRIBE, key_serial_t key, char *buffer,
532                     size_t buflen);
533
534      This function returns a summary of the key's attributes (but not its
535      payload data) as a string in the buffer provided.
536
537      Unless there's an error, it always returns the amount of data it could
538      produce, even if that's too big for the buffer, but it won't copy more
539      than requested to userspace. If the buffer pointer is NULL then no copy
540      will take place.
541
542      A process must have view permission on the key for this function to be
543      successful.
544
545      If successful, a string is placed in the buffer in the following format::
546
547         <type>;<uid>;<gid>;<perm>;<description>
548
549      Where type and description are strings, uid and gid are decimal, and perm
550      is hexadecimal. A NUL character is included at the end of the string if
551      the buffer is sufficiently big.
552
553      This can be parsed with::
554
555         sscanf(buffer, "%[^;];%d;%d;%o;%s", type, &uid, &gid, &mode, desc);
556
557
558   *  Clear out a keyring::
559
560         long keyctl(KEYCTL_CLEAR, key_serial_t keyring);
561
562      This function clears the list of keys attached to a keyring. The calling
563      process must have write permission on the keyring, and it must be a
564      keyring (or else error ENOTDIR will result).
565
566      This function can also be used to clear special kernel keyrings if they
567      are appropriately marked if the user has CAP_SYS_ADMIN capability.  The
568      DNS resolver cache keyring is an example of this.
569
570
571   *  Link a key into a keyring::
572
573         long keyctl(KEYCTL_LINK, key_serial_t keyring, key_serial_t key);
574
575      This function creates a link from the keyring to the key. The process must
576      have write permission on the keyring and must have link permission on the
577      key.
578
579      Should the keyring not be a keyring, error ENOTDIR will result; and if the
580      keyring is full, error ENFILE will result.
581
582      The link procedure checks the nesting of the keyrings, returning ELOOP if
583      it appears too deep or EDEADLK if the link would introduce a cycle.
584
585      Any links within the keyring to keys that match the new key in terms of
586      type and description will be discarded from the keyring as the new one is
587      added.
588
589
590   *  Unlink a key or keyring from another keyring::
591
592         long keyctl(KEYCTL_UNLINK, key_serial_t keyring, key_serial_t key);
593
594      This function looks through the keyring for the first link to the
595      specified key, and removes it if found. Subsequent links to that key are
596      ignored. The process must have write permission on the keyring.
597
598      If the keyring is not a keyring, error ENOTDIR will result; and if the key
599      is not present, error ENOENT will be the result.
600
601
602   *  Search a keyring tree for a key::
603
604         key_serial_t keyctl(KEYCTL_SEARCH, key_serial_t keyring,
605                             const char *type, const char *description,
606                             key_serial_t dest_keyring);
607
608      This searches the keyring tree headed by the specified keyring until a key
609      is found that matches the type and description criteria. Each keyring is
610      checked for keys before recursion into its children occurs.
611
612      The process must have search permission on the top level keyring, or else
613      error EACCES will result. Only keyrings that the process has search
614      permission on will be recursed into, and only keys and keyrings for which
615      a process has search permission can be matched. If the specified keyring
616      is not a keyring, ENOTDIR will result.
617
618      If the search succeeds, the function will attempt to link the found key
619      into the destination keyring if one is supplied (non-zero ID). All the
620      constraints applicable to KEYCTL_LINK apply in this case too.
621
622      Error ENOKEY, EKEYREVOKED or EKEYEXPIRED will be returned if the search
623      fails. On success, the resulting key ID will be returned.
624
625
626   *  Read the payload data from a key::
627
628         long keyctl(KEYCTL_READ, key_serial_t keyring, char *buffer,
629                     size_t buflen);
630
631      This function attempts to read the payload data from the specified key
632      into the buffer. The process must have read permission on the key to
633      succeed.
634
635      The returned data will be processed for presentation by the key type. For
636      instance, a keyring will return an array of key_serial_t entries
637      representing the IDs of all the keys to which it is subscribed. The user
638      defined key type will return its data as is. If a key type does not
639      implement this function, error EOPNOTSUPP will result.
640
641      As much of the data as can be fitted into the buffer will be copied to
642      userspace if the buffer pointer is not NULL.
643
644      On a successful return, the function will always return the amount of data
645      available rather than the amount copied.
646
647
648   *  Instantiate a partially constructed key::
649
650         long keyctl(KEYCTL_INSTANTIATE, key_serial_t key,
651                     const void *payload, size_t plen,
652                     key_serial_t keyring);
653         long keyctl(KEYCTL_INSTANTIATE_IOV, key_serial_t key,
654                     const struct iovec *payload_iov, unsigned ioc,
655                     key_serial_t keyring);
656
657      If the kernel calls back to userspace to complete the instantiation of a
658      key, userspace should use this call to supply data for the key before the
659      invoked process returns, or else the key will be marked negative
660      automatically.
661
662      The process must have write access on the key to be able to instantiate
663      it, and the key must be uninstantiated.
664
665      If a keyring is specified (non-zero), the key will also be linked into
666      that keyring, however all the constraints applying in KEYCTL_LINK apply in
667      this case too.
668
669      The payload and plen arguments describe the payload data as for add_key().
670
671      The payload_iov and ioc arguments describe the payload data in an iovec
672      array instead of a single buffer.
673
674
675   *  Negatively instantiate a partially constructed key::
676
677         long keyctl(KEYCTL_NEGATE, key_serial_t key,
678                     unsigned timeout, key_serial_t keyring);
679         long keyctl(KEYCTL_REJECT, key_serial_t key,
680                     unsigned timeout, unsigned error, key_serial_t keyring);
681
682      If the kernel calls back to userspace to complete the instantiation of a
683      key, userspace should use this call mark the key as negative before the
684      invoked process returns if it is unable to fulfill the request.
685
686      The process must have write access on the key to be able to instantiate
687      it, and the key must be uninstantiated.
688
689      If a keyring is specified (non-zero), the key will also be linked into
690      that keyring, however all the constraints applying in KEYCTL_LINK apply in
691      this case too.
692
693      If the key is rejected, future searches for it will return the specified
694      error code until the rejected key expires.  Negating the key is the same
695      as rejecting the key with ENOKEY as the error code.
696
697
698   *  Set the default request-key destination keyring::
699
700         long keyctl(KEYCTL_SET_REQKEY_KEYRING, int reqkey_defl);
701
702      This sets the default keyring to which implicitly requested keys will be
703      attached for this thread. reqkey_defl should be one of these constants::
704
705         CONSTANT                                VALUE   NEW DEFAULT KEYRING
706         ======================================  ======  =======================
707         KEY_REQKEY_DEFL_NO_CHANGE               -1      No change
708         KEY_REQKEY_DEFL_DEFAULT                 0       Default[1]
709         KEY_REQKEY_DEFL_THREAD_KEYRING          1       Thread keyring
710         KEY_REQKEY_DEFL_PROCESS_KEYRING         2       Process keyring
711         KEY_REQKEY_DEFL_SESSION_KEYRING         3       Session keyring
712         KEY_REQKEY_DEFL_USER_KEYRING            4       User keyring
713         KEY_REQKEY_DEFL_USER_SESSION_KEYRING    5       User session keyring
714         KEY_REQKEY_DEFL_GROUP_KEYRING           6       Group keyring
715
716      The old default will be returned if successful and error EINVAL will be
717      returned if reqkey_defl is not one of the above values.
718
719      The default keyring can be overridden by the keyring indicated to the
720      request_key() system call.
721
722      Note that this setting is inherited across fork/exec.
723
724      [1] The default is: the thread keyring if there is one, otherwise
725      the process keyring if there is one, otherwise the session keyring if
726      there is one, otherwise the user default session keyring.
727
728
729   *  Set the timeout on a key::
730
731         long keyctl(KEYCTL_SET_TIMEOUT, key_serial_t key, unsigned timeout);
732
733      This sets or clears the timeout on a key. The timeout can be 0 to clear
734      the timeout or a number of seconds to set the expiry time that far into
735      the future.
736
737      The process must have attribute modification access on a key to set its
738      timeout. Timeouts may not be set with this function on negative, revoked
739      or expired keys.
740
741
742   *  Assume the authority granted to instantiate a key::
743
744         long keyctl(KEYCTL_ASSUME_AUTHORITY, key_serial_t key);
745
746      This assumes or divests the authority required to instantiate the
747      specified key. Authority can only be assumed if the thread has the
748      authorisation key associated with the specified key in its keyrings
749      somewhere.
750
751      Once authority is assumed, searches for keys will also search the
752      requester's keyrings using the requester's security label, UID, GID and
753      groups.
754
755      If the requested authority is unavailable, error EPERM will be returned,
756      likewise if the authority has been revoked because the target key is
757      already instantiated.
758
759      If the specified key is 0, then any assumed authority will be divested.
760
761      The assumed authoritative key is inherited across fork and exec.
762
763
764   *  Get the LSM security context attached to a key::
765
766         long keyctl(KEYCTL_GET_SECURITY, key_serial_t key, char *buffer,
767                     size_t buflen)
768
769      This function returns a string that represents the LSM security context
770      attached to a key in the buffer provided.
771
772      Unless there's an error, it always returns the amount of data it could
773      produce, even if that's too big for the buffer, but it won't copy more
774      than requested to userspace. If the buffer pointer is NULL then no copy
775      will take place.
776
777      A NUL character is included at the end of the string if the buffer is
778      sufficiently big.  This is included in the returned count.  If no LSM is
779      in force then an empty string will be returned.
780
781      A process must have view permission on the key for this function to be
782      successful.
783
784
785   *  Install the calling process's session keyring on its parent::
786
787         long keyctl(KEYCTL_SESSION_TO_PARENT);
788
789      This functions attempts to install the calling process's session keyring
790      on to the calling process's parent, replacing the parent's current session
791      keyring.
792
793      The calling process must have the same ownership as its parent, the
794      keyring must have the same ownership as the calling process, the calling
795      process must have LINK permission on the keyring and the active LSM module
796      mustn't deny permission, otherwise error EPERM will be returned.
797
798      Error ENOMEM will be returned if there was insufficient memory to complete
799      the operation, otherwise 0 will be returned to indicate success.
800
801      The keyring will be replaced next time the parent process leaves the
802      kernel and resumes executing userspace.
803
804
805   *  Invalidate a key::
806
807         long keyctl(KEYCTL_INVALIDATE, key_serial_t key);
808
809      This function marks a key as being invalidated and then wakes up the
810      garbage collector.  The garbage collector immediately removes invalidated
811      keys from all keyrings and deletes the key when its reference count
812      reaches zero.
813
814      Keys that are marked invalidated become invisible to normal key operations
815      immediately, though they are still visible in /proc/keys until deleted
816      (they're marked with an 'i' flag).
817
818      A process must have search permission on the key for this function to be
819      successful.
820
821   *  Compute a Diffie-Hellman shared secret or public key::
822
823         long keyctl(KEYCTL_DH_COMPUTE, struct keyctl_dh_params *params,
824                     char *buffer, size_t buflen, struct keyctl_kdf_params *kdf);
825
826      The params struct contains serial numbers for three keys::
827
828          - The prime, p, known to both parties
829          - The local private key
830          - The base integer, which is either a shared generator or the
831            remote public key
832
833      The value computed is::
834
835         result = base ^ private (mod prime)
836
837      If the base is the shared generator, the result is the local
838      public key.  If the base is the remote public key, the result is
839      the shared secret.
840
841      If the parameter kdf is NULL, the following applies:
842
843          - The buffer length must be at least the length of the prime, or zero.
844
845          - If the buffer length is nonzero, the length of the result is
846            returned when it is successfully calculated and copied in to the
847            buffer. When the buffer length is zero, the minimum required
848            buffer length is returned.
849
850      The kdf parameter allows the caller to apply a key derivation function
851      (KDF) on the Diffie-Hellman computation where only the result
852      of the KDF is returned to the caller. The KDF is characterized with
853      struct keyctl_kdf_params as follows:
854
855          - ``char *hashname`` specifies the NUL terminated string identifying
856            the hash used from the kernel crypto API and applied for the KDF
857            operation. The KDF implemenation complies with SP800-56A as well
858            as with SP800-108 (the counter KDF).
859
860          - ``char *otherinfo`` specifies the OtherInfo data as documented in
861            SP800-56A section 5.8.1.2. The length of the buffer is given with
862            otherinfolen. The format of OtherInfo is defined by the caller.
863            The otherinfo pointer may be NULL if no OtherInfo shall be used.
864
865      This function will return error EOPNOTSUPP if the key type is not
866      supported, error ENOKEY if the key could not be found, or error
867      EACCES if the key is not readable by the caller. In addition, the
868      function will return EMSGSIZE when the parameter kdf is non-NULL
869      and either the buffer length or the OtherInfo length exceeds the
870      allowed length.
871
872   *  Restrict keyring linkage::
873
874         long keyctl(KEYCTL_RESTRICT_KEYRING, key_serial_t keyring,
875                     const char *type, const char *restriction);
876
877      An existing keyring can restrict linkage of additional keys by evaluating
878      the contents of the key according to a restriction scheme.
879
880      "keyring" is the key ID for an existing keyring to apply a restriction
881      to. It may be empty or may already have keys linked. Existing linked keys
882      will remain in the keyring even if the new restriction would reject them.
883
884      "type" is a registered key type.
885
886      "restriction" is a string describing how key linkage is to be restricted.
887      The format varies depending on the key type, and the string is passed to
888      the lookup_restriction() function for the requested type.  It may specify
889      a method and relevant data for the restriction such as signature
890      verification or constraints on key payload. If the requested key type is
891      later unregistered, no keys may be added to the keyring after the key type
892      is removed.
893
894      To apply a keyring restriction the process must have Set Attribute
895      permission and the keyring must not be previously restricted.
896
897 Kernel Services
898 ===============
899
900 The kernel services for key management are fairly simple to deal with. They can
901 be broken down into two areas: keys and key types.
902
903 Dealing with keys is fairly straightforward. Firstly, the kernel service
904 registers its type, then it searches for a key of that type. It should retain
905 the key as long as it has need of it, and then it should release it. For a
906 filesystem or device file, a search would probably be performed during the open
907 call, and the key released upon close. How to deal with conflicting keys due to
908 two different users opening the same file is left to the filesystem author to
909 solve.
910
911 To access the key manager, the following header must be #included::
912
913         <linux/key.h>
914
915 Specific key types should have a header file under include/keys/ that should be
916 used to access that type.  For keys of type "user", for example, that would be::
917
918         <keys/user-type.h>
919
920 Note that there are two different types of pointers to keys that may be
921 encountered:
922
923   *  struct key *
924
925      This simply points to the key structure itself. Key structures will be at
926      least four-byte aligned.
927
928   *  key_ref_t
929
930      This is equivalent to a ``struct key *``, but the least significant bit is set
931      if the caller "possesses" the key. By "possession" it is meant that the
932      calling processes has a searchable link to the key from one of its
933      keyrings. There are three functions for dealing with these::
934
935         key_ref_t make_key_ref(const struct key *key, bool possession);
936
937         struct key *key_ref_to_ptr(const key_ref_t key_ref);
938
939         bool is_key_possessed(const key_ref_t key_ref);
940
941      The first function constructs a key reference from a key pointer and
942      possession information (which must be true or false).
943
944      The second function retrieves the key pointer from a reference and the
945      third retrieves the possession flag.
946
947 When accessing a key's payload contents, certain precautions must be taken to
948 prevent access vs modification races. See the section "Notes on accessing
949 payload contents" for more information.
950
951  *  To search for a key, call::
952
953         struct key *request_key(const struct key_type *type,
954                                 const char *description,
955                                 const char *callout_info);
956
957     This is used to request a key or keyring with a description that matches
958     the description specified according to the key type's match_preparse()
959     method. This permits approximate matching to occur. If callout_string is
960     not NULL, then /sbin/request-key will be invoked in an attempt to obtain
961     the key from userspace. In that case, callout_string will be passed as an
962     argument to the program.
963
964     Should the function fail error ENOKEY, EKEYEXPIRED or EKEYREVOKED will be
965     returned.
966
967     If successful, the key will have been attached to the default keyring for
968     implicitly obtained request-key keys, as set by KEYCTL_SET_REQKEY_KEYRING.
969
970     See also Documentation/security/keys-request-key.txt.
971
972
973  *  To search for a key, passing auxiliary data to the upcaller, call::
974
975         struct key *request_key_with_auxdata(const struct key_type *type,
976                                              const char *description,
977                                              const void *callout_info,
978                                              size_t callout_len,
979                                              void *aux);
980
981     This is identical to request_key(), except that the auxiliary data is
982     passed to the key_type->request_key() op if it exists, and the callout_info
983     is a blob of length callout_len, if given (the length may be 0).
984
985
986  *  A key can be requested asynchronously by calling one of::
987
988         struct key *request_key_async(const struct key_type *type,
989                                       const char *description,
990                                       const void *callout_info,
991                                       size_t callout_len);
992
993     or::
994
995         struct key *request_key_async_with_auxdata(const struct key_type *type,
996                                                    const char *description,
997                                                    const char *callout_info,
998                                                    size_t callout_len,
999                                                    void *aux);
1000
1001     which are asynchronous equivalents of request_key() and
1002     request_key_with_auxdata() respectively.
1003
1004     These two functions return with the key potentially still under
1005     construction.  To wait for construction completion, the following should be
1006     called::
1007
1008         int wait_for_key_construction(struct key *key, bool intr);
1009
1010     The function will wait for the key to finish being constructed and then
1011     invokes key_validate() to return an appropriate value to indicate the state
1012     of the key (0 indicates the key is usable).
1013
1014     If intr is true, then the wait can be interrupted by a signal, in which
1015     case error ERESTARTSYS will be returned.
1016
1017
1018  *  When it is no longer required, the key should be released using::
1019
1020         void key_put(struct key *key);
1021
1022     Or::
1023
1024         void key_ref_put(key_ref_t key_ref);
1025
1026     These can be called from interrupt context. If CONFIG_KEYS is not set then
1027     the argument will not be parsed.
1028
1029
1030  *  Extra references can be made to a key by calling one of the following
1031     functions::
1032
1033         struct key *__key_get(struct key *key);
1034         struct key *key_get(struct key *key);
1035
1036     Keys so references will need to be disposed of by calling key_put() when
1037     they've been finished with.  The key pointer passed in will be returned.
1038
1039     In the case of key_get(), if the pointer is NULL or CONFIG_KEYS is not set
1040     then the key will not be dereferenced and no increment will take place.
1041
1042
1043  *  A key's serial number can be obtained by calling::
1044
1045         key_serial_t key_serial(struct key *key);
1046
1047     If key is NULL or if CONFIG_KEYS is not set then 0 will be returned (in the
1048     latter case without parsing the argument).
1049
1050
1051  *  If a keyring was found in the search, this can be further searched by::
1052
1053         key_ref_t keyring_search(key_ref_t keyring_ref,
1054                                  const struct key_type *type,
1055                                  const char *description)
1056
1057     This searches the keyring tree specified for a matching key. Error ENOKEY
1058     is returned upon failure (use IS_ERR/PTR_ERR to determine). If successful,
1059     the returned key will need to be released.
1060
1061     The possession attribute from the keyring reference is used to control
1062     access through the permissions mask and is propagated to the returned key
1063     reference pointer if successful.
1064
1065
1066  *  A keyring can be created by::
1067
1068         struct key *keyring_alloc(const char *description, uid_t uid, gid_t gid,
1069                                   const struct cred *cred,
1070                                   key_perm_t perm,
1071                                   struct key_restriction *restrict_link,
1072                                   unsigned long flags,
1073                                   struct key *dest);
1074
1075     This creates a keyring with the given attributes and returns it.  If dest
1076     is not NULL, the new keyring will be linked into the keyring to which it
1077     points.  No permission checks are made upon the destination keyring.
1078
1079     Error EDQUOT can be returned if the keyring would overload the quota (pass
1080     KEY_ALLOC_NOT_IN_QUOTA in flags if the keyring shouldn't be accounted
1081     towards the user's quota).  Error ENOMEM can also be returned.
1082
1083     If restrict_link is not NULL, it should point to a structure that contains
1084     the function that will be called each time an attempt is made to link a
1085     key into the new keyring.  The structure may also contain a key pointer
1086     and an associated key type.  The function is called to check whether a key
1087     may be added into the keyring or not.  The key type is used by the garbage
1088     collector to clean up function or data pointers in this structure if the
1089     given key type is unregistered.  Callers of key_create_or_update() within
1090     the kernel can pass KEY_ALLOC_BYPASS_RESTRICTION to suppress the check.
1091     An example of using this is to manage rings of cryptographic keys that are
1092     set up when the kernel boots where userspace is also permitted to add keys
1093     - provided they can be verified by a key the kernel already has.
1094
1095     When called, the restriction function will be passed the keyring being
1096     added to, the key type, the payload of the key being added, and data to be
1097     used in the restriction check.  Note that when a new key is being created,
1098     this is called between payload preparsing and actual key creation.  The
1099     function should return 0 to allow the link or an error to reject it.
1100
1101     A convenience function, restrict_link_reject, exists to always return
1102     -EPERM to in this case.
1103
1104
1105  *  To check the validity of a key, this function can be called::
1106
1107         int validate_key(struct key *key);
1108
1109     This checks that the key in question hasn't expired or and hasn't been
1110     revoked. Should the key be invalid, error EKEYEXPIRED or EKEYREVOKED will
1111     be returned. If the key is NULL or if CONFIG_KEYS is not set then 0 will be
1112     returned (in the latter case without parsing the argument).
1113
1114
1115  *  To register a key type, the following function should be called::
1116
1117         int register_key_type(struct key_type *type);
1118
1119     This will return error EEXIST if a type of the same name is already
1120     present.
1121
1122
1123  *  To unregister a key type, call::
1124
1125         void unregister_key_type(struct key_type *type);
1126
1127
1128 Under some circumstances, it may be desirable to deal with a bundle of keys.
1129 The facility provides access to the keyring type for managing such a bundle::
1130
1131         struct key_type key_type_keyring;
1132
1133 This can be used with a function such as request_key() to find a specific
1134 keyring in a process's keyrings.  A keyring thus found can then be searched
1135 with keyring_search().  Note that it is not possible to use request_key() to
1136 search a specific keyring, so using keyrings in this way is of limited utility.
1137
1138
1139 Notes On Accessing Payload Contents
1140 ===================================
1141
1142 The simplest payload is just data stored in key->payload directly.  In this
1143 case, there's no need to indulge in RCU or locking when accessing the payload.
1144
1145 More complex payload contents must be allocated and pointers to them set in the
1146 key->payload.data[] array.  One of the following ways must be selected to
1147 access the data:
1148
1149   1) Unmodifiable key type.
1150
1151      If the key type does not have a modify method, then the key's payload can
1152      be accessed without any form of locking, provided that it's known to be
1153      instantiated (uninstantiated keys cannot be "found").
1154
1155   2) The key's semaphore.
1156
1157      The semaphore could be used to govern access to the payload and to control
1158      the payload pointer. It must be write-locked for modifications and would
1159      have to be read-locked for general access. The disadvantage of doing this
1160      is that the accessor may be required to sleep.
1161
1162   3) RCU.
1163
1164      RCU must be used when the semaphore isn't already held; if the semaphore
1165      is held then the contents can't change under you unexpectedly as the
1166      semaphore must still be used to serialise modifications to the key. The
1167      key management code takes care of this for the key type.
1168
1169      However, this means using::
1170
1171         rcu_read_lock() ... rcu_dereference() ... rcu_read_unlock()
1172
1173      to read the pointer, and::
1174
1175         rcu_dereference() ... rcu_assign_pointer() ... call_rcu()
1176
1177      to set the pointer and dispose of the old contents after a grace period.
1178      Note that only the key type should ever modify a key's payload.
1179
1180      Furthermore, an RCU controlled payload must hold a struct rcu_head for the
1181      use of call_rcu() and, if the payload is of variable size, the length of
1182      the payload. key->datalen cannot be relied upon to be consistent with the
1183      payload just dereferenced if the key's semaphore is not held.
1184
1185      Note that key->payload.data[0] has a shadow that is marked for __rcu
1186      usage.  This is called key->payload.rcu_data0.  The following accessors
1187      wrap the RCU calls to this element:
1188
1189      a) Set or change the first payload pointer::
1190
1191                 rcu_assign_keypointer(struct key *key, void *data);
1192
1193      b) Read the first payload pointer with the key semaphore held::
1194
1195                 [const] void *dereference_key_locked([const] struct key *key);
1196
1197          Note that the return value will inherit its constness from the key
1198          parameter.  Static analysis will give an error if it things the lock
1199          isn't held.
1200
1201      c) Read the first payload pointer with the RCU read lock held::
1202
1203                 const void *dereference_key_rcu(const struct key *key);
1204
1205
1206 Defining a Key Type
1207 ===================
1208
1209 A kernel service may want to define its own key type. For instance, an AFS
1210 filesystem might want to define a Kerberos 5 ticket key type. To do this, it
1211 author fills in a key_type struct and registers it with the system.
1212
1213 Source files that implement key types should include the following header file::
1214
1215         <linux/key-type.h>
1216
1217 The structure has a number of fields, some of which are mandatory:
1218
1219   *  ``const char *name``
1220
1221      The name of the key type. This is used to translate a key type name
1222      supplied by userspace into a pointer to the structure.
1223
1224
1225   *  ``size_t def_datalen``
1226
1227      This is optional - it supplies the default payload data length as
1228      contributed to the quota. If the key type's payload is always or almost
1229      always the same size, then this is a more efficient way to do things.
1230
1231      The data length (and quota) on a particular key can always be changed
1232      during instantiation or update by calling::
1233
1234         int key_payload_reserve(struct key *key, size_t datalen);
1235
1236      With the revised data length. Error EDQUOT will be returned if this is not
1237      viable.
1238
1239
1240   *  ``int (*vet_description)(const char *description);``
1241
1242      This optional method is called to vet a key description.  If the key type
1243      doesn't approve of the key description, it may return an error, otherwise
1244      it should return 0.
1245
1246
1247   *  ``int (*preparse)(struct key_preparsed_payload *prep);``
1248
1249      This optional method permits the key type to attempt to parse payload
1250      before a key is created (add key) or the key semaphore is taken (update or
1251      instantiate key).  The structure pointed to by prep looks like::
1252
1253         struct key_preparsed_payload {
1254                 char            *description;
1255                 union key_payload payload;
1256                 const void      *data;
1257                 size_t          datalen;
1258                 size_t          quotalen;
1259                 time_t          expiry;
1260         };
1261
1262      Before calling the method, the caller will fill in data and datalen with
1263      the payload blob parameters; quotalen will be filled in with the default
1264      quota size from the key type; expiry will be set to TIME_T_MAX and the
1265      rest will be cleared.
1266
1267      If a description can be proposed from the payload contents, that should be
1268      attached as a string to the description field.  This will be used for the
1269      key description if the caller of add_key() passes NULL or "".
1270
1271      The method can attach anything it likes to payload.  This is merely passed
1272      along to the instantiate() or update() operations.  If set, the expiry
1273      time will be applied to the key if it is instantiated from this data.
1274
1275      The method should return 0 if successful or a negative error code
1276      otherwise.
1277
1278
1279   *  ``void (*free_preparse)(struct key_preparsed_payload *prep);``
1280
1281      This method is only required if the preparse() method is provided,
1282      otherwise it is unused.  It cleans up anything attached to the description
1283      and payload fields of the key_preparsed_payload struct as filled in by the
1284      preparse() method.  It will always be called after preparse() returns
1285      successfully, even if instantiate() or update() succeed.
1286
1287
1288   *  ``int (*instantiate)(struct key *key, struct key_preparsed_payload *prep);``
1289
1290      This method is called to attach a payload to a key during construction.
1291      The payload attached need not bear any relation to the data passed to this
1292      function.
1293
1294      The prep->data and prep->datalen fields will define the original payload
1295      blob.  If preparse() was supplied then other fields may be filled in also.
1296
1297      If the amount of data attached to the key differs from the size in
1298      keytype->def_datalen, then key_payload_reserve() should be called.
1299
1300      This method does not have to lock the key in order to attach a payload.
1301      The fact that KEY_FLAG_INSTANTIATED is not set in key->flags prevents
1302      anything else from gaining access to the key.
1303
1304      It is safe to sleep in this method.
1305
1306      generic_key_instantiate() is provided to simply copy the data from
1307      prep->payload.data[] to key->payload.data[], with RCU-safe assignment on
1308      the first element.  It will then clear prep->payload.data[] so that the
1309      free_preparse method doesn't release the data.
1310
1311
1312   *  ``int (*update)(struct key *key, const void *data, size_t datalen);``
1313
1314      If this type of key can be updated, then this method should be provided.
1315      It is called to update a key's payload from the blob of data provided.
1316
1317      The prep->data and prep->datalen fields will define the original payload
1318      blob.  If preparse() was supplied then other fields may be filled in also.
1319
1320      key_payload_reserve() should be called if the data length might change
1321      before any changes are actually made. Note that if this succeeds, the type
1322      is committed to changing the key because it's already been altered, so all
1323      memory allocation must be done first.
1324
1325      The key will have its semaphore write-locked before this method is called,
1326      but this only deters other writers; any changes to the key's payload must
1327      be made under RCU conditions, and call_rcu() must be used to dispose of
1328      the old payload.
1329
1330      key_payload_reserve() should be called before the changes are made, but
1331      after all allocations and other potentially failing function calls are
1332      made.
1333
1334      It is safe to sleep in this method.
1335
1336
1337   *  ``int (*match_preparse)(struct key_match_data *match_data);``
1338
1339      This method is optional.  It is called when a key search is about to be
1340      performed.  It is given the following structure::
1341
1342         struct key_match_data {
1343                 bool (*cmp)(const struct key *key,
1344                             const struct key_match_data *match_data);
1345                 const void      *raw_data;
1346                 void            *preparsed;
1347                 unsigned        lookup_type;
1348         };
1349
1350      On entry, raw_data will be pointing to the criteria to be used in matching
1351      a key by the caller and should not be modified.  ``(*cmp)()`` will be pointing
1352      to the default matcher function (which does an exact description match
1353      against raw_data) and lookup_type will be set to indicate a direct lookup.
1354
1355      The following lookup_type values are available:
1356
1357        *  KEYRING_SEARCH_LOOKUP_DIRECT - A direct lookup hashes the type and
1358           description to narrow down the search to a small number of keys.
1359
1360        *  KEYRING_SEARCH_LOOKUP_ITERATE - An iterative lookup walks all the
1361           keys in the keyring until one is matched.  This must be used for any
1362           search that's not doing a simple direct match on the key description.
1363
1364      The method may set cmp to point to a function of its choice that does some
1365      other form of match, may set lookup_type to KEYRING_SEARCH_LOOKUP_ITERATE
1366      and may attach something to the preparsed pointer for use by ``(*cmp)()``.
1367      ``(*cmp)()`` should return true if a key matches and false otherwise.
1368
1369      If preparsed is set, it may be necessary to use the match_free() method to
1370      clean it up.
1371
1372      The method should return 0 if successful or a negative error code
1373      otherwise.
1374
1375      It is permitted to sleep in this method, but ``(*cmp)()`` may not sleep as
1376      locks will be held over it.
1377
1378      If match_preparse() is not provided, keys of this type will be matched
1379      exactly by their description.
1380
1381
1382   *  ``void (*match_free)(struct key_match_data *match_data);``
1383
1384      This method is optional.  If given, it called to clean up
1385      match_data->preparsed after a successful call to match_preparse().
1386
1387
1388   *  ``void (*revoke)(struct key *key);``
1389
1390      This method is optional.  It is called to discard part of the payload
1391      data upon a key being revoked.  The caller will have the key semaphore
1392      write-locked.
1393
1394      It is safe to sleep in this method, though care should be taken to avoid
1395      a deadlock against the key semaphore.
1396
1397
1398   *  ``void (*destroy)(struct key *key);``
1399
1400      This method is optional. It is called to discard the payload data on a key
1401      when it is being destroyed.
1402
1403      This method does not need to lock the key to access the payload; it can
1404      consider the key as being inaccessible at this time. Note that the key's
1405      type may have been changed before this function is called.
1406
1407      It is not safe to sleep in this method; the caller may hold spinlocks.
1408
1409
1410   *  ``void (*describe)(const struct key *key, struct seq_file *p);``
1411
1412      This method is optional. It is called during /proc/keys reading to
1413      summarise a key's description and payload in text form.
1414
1415      This method will be called with the RCU read lock held. rcu_dereference()
1416      should be used to read the payload pointer if the payload is to be
1417      accessed. key->datalen cannot be trusted to stay consistent with the
1418      contents of the payload.
1419
1420      The description will not change, though the key's state may.
1421
1422      It is not safe to sleep in this method; the RCU read lock is held by the
1423      caller.
1424
1425
1426   *  ``long (*read)(const struct key *key, char __user *buffer, size_t buflen);``
1427
1428      This method is optional. It is called by KEYCTL_READ to translate the
1429      key's payload into something a blob of data for userspace to deal with.
1430      Ideally, the blob should be in the same format as that passed in to the
1431      instantiate and update methods.
1432
1433      If successful, the blob size that could be produced should be returned
1434      rather than the size copied.
1435
1436      This method will be called with the key's semaphore read-locked. This will
1437      prevent the key's payload changing. It is not necessary to use RCU locking
1438      when accessing the key's payload. It is safe to sleep in this method, such
1439      as might happen when the userspace buffer is accessed.
1440
1441
1442   *  ``int (*request_key)(struct key_construction *cons, const char *op, void *aux);``
1443
1444      This method is optional.  If provided, request_key() and friends will
1445      invoke this function rather than upcalling to /sbin/request-key to operate
1446      upon a key of this type.
1447
1448      The aux parameter is as passed to request_key_async_with_auxdata() and
1449      similar or is NULL otherwise.  Also passed are the construction record for
1450      the key to be operated upon and the operation type (currently only
1451      "create").
1452
1453      This method is permitted to return before the upcall is complete, but the
1454      following function must be called under all circumstances to complete the
1455      instantiation process, whether or not it succeeds, whether or not there's
1456      an error::
1457
1458         void complete_request_key(struct key_construction *cons, int error);
1459
1460      The error parameter should be 0 on success, -ve on error.  The
1461      construction record is destroyed by this action and the authorisation key
1462      will be revoked.  If an error is indicated, the key under construction
1463      will be negatively instantiated if it wasn't already instantiated.
1464
1465      If this method returns an error, that error will be returned to the
1466      caller of request_key*().  complete_request_key() must be called prior to
1467      returning.
1468
1469      The key under construction and the authorisation key can be found in the
1470      key_construction struct pointed to by cons:
1471
1472       *  ``struct key *key;``
1473
1474          The key under construction.
1475
1476       *  ``struct key *authkey;``
1477
1478          The authorisation key.
1479
1480
1481   *  ``struct key_restriction *(*lookup_restriction)(const char *params);``
1482
1483      This optional method is used to enable userspace configuration of keyring
1484      restrictions. The restriction parameter string (not including the key type
1485      name) is passed in, and this method returns a pointer to a key_restriction
1486      structure containing the relevant functions and data to evaluate each
1487      attempted key link operation. If there is no match, -EINVAL is returned.
1488
1489
1490 Request-Key Callback Service
1491 ============================
1492
1493 To create a new key, the kernel will attempt to execute the following command
1494 line::
1495
1496         /sbin/request-key create <key> <uid> <gid> \
1497                 <threadring> <processring> <sessionring> <callout_info>
1498
1499 <key> is the key being constructed, and the three keyrings are the process
1500 keyrings from the process that caused the search to be issued. These are
1501 included for two reasons:
1502
1503    1  There may be an authentication token in one of the keyrings that is
1504       required to obtain the key, eg: a Kerberos Ticket-Granting Ticket.
1505
1506    2  The new key should probably be cached in one of these rings.
1507
1508 This program should set it UID and GID to those specified before attempting to
1509 access any more keys. It may then look around for a user specific process to
1510 hand the request off to (perhaps a path held in placed in another key by, for
1511 example, the KDE desktop manager).
1512
1513 The program (or whatever it calls) should finish construction of the key by
1514 calling KEYCTL_INSTANTIATE or KEYCTL_INSTANTIATE_IOV, which also permits it to
1515 cache the key in one of the keyrings (probably the session ring) before
1516 returning.  Alternatively, the key can be marked as negative with KEYCTL_NEGATE
1517 or KEYCTL_REJECT; this also permits the key to be cached in one of the
1518 keyrings.
1519
1520 If it returns with the key remaining in the unconstructed state, the key will
1521 be marked as being negative, it will be added to the session keyring, and an
1522 error will be returned to the key requestor.
1523
1524 Supplementary information may be provided from whoever or whatever invoked this
1525 service. This will be passed as the <callout_info> parameter. If no such
1526 information was made available, then "-" will be passed as this parameter
1527 instead.
1528
1529
1530 Similarly, the kernel may attempt to update an expired or a soon to expire key
1531 by executing::
1532
1533         /sbin/request-key update <key> <uid> <gid> \
1534                 <threadring> <processring> <sessionring>
1535
1536 In this case, the program isn't required to actually attach the key to a ring;
1537 the rings are provided for reference.
1538
1539
1540 Garbage Collection
1541 ==================
1542
1543 Dead keys (for which the type has been removed) will be automatically unlinked
1544 from those keyrings that point to them and deleted as soon as possible by a
1545 background garbage collector.
1546
1547 Similarly, revoked and expired keys will be garbage collected, but only after a
1548 certain amount of time has passed.  This time is set as a number of seconds in::
1549
1550         /proc/sys/kernel/keys/gc_delay