diff options
Diffstat (limited to 'Documentation/keys-request-key.txt')
-rw-r--r-- | Documentation/keys-request-key.txt | 25 |
1 files changed, 21 insertions, 4 deletions
diff --git a/Documentation/keys-request-key.txt b/Documentation/keys-request-key.txt index c1f64fdf84cb..266955d23ee6 100644 --- a/Documentation/keys-request-key.txt +++ b/Documentation/keys-request-key.txt | |||
@@ -20,6 +20,19 @@ or: | |||
20 | const char *callout_string, | 20 | const char *callout_string, |
21 | void *aux); | 21 | void *aux); |
22 | 22 | ||
23 | or: | ||
24 | |||
25 | struct key *request_key_async(const struct key_type *type, | ||
26 | const char *description, | ||
27 | const char *callout_string); | ||
28 | |||
29 | or: | ||
30 | |||
31 | struct key *request_key_async_with_auxdata(const struct key_type *type, | ||
32 | const char *description, | ||
33 | const char *callout_string, | ||
34 | void *aux); | ||
35 | |||
23 | Or by userspace invoking the request_key system call: | 36 | Or by userspace invoking the request_key system call: |
24 | 37 | ||
25 | key_serial_t request_key(const char *type, | 38 | key_serial_t request_key(const char *type, |
@@ -32,10 +45,14 @@ does not need to link the key to a keyring to prevent it from being immediately | |||
32 | destroyed. The kernel interface returns a pointer directly to the key, and | 45 | destroyed. The kernel interface returns a pointer directly to the key, and |
33 | it's up to the caller to destroy the key. | 46 | it's up to the caller to destroy the key. |
34 | 47 | ||
35 | The request_key_with_auxdata() call is like the in-kernel request_key() call, | 48 | The request_key*_with_auxdata() calls are like the in-kernel request_key*() |
36 | except that it permits auxiliary data to be passed to the upcaller (the default | 49 | calls, except that they permit auxiliary data to be passed to the upcaller (the |
37 | is NULL). This is only useful for those key types that define their own upcall | 50 | default is NULL). This is only useful for those key types that define their |
38 | mechanism rather than using /sbin/request-key. | 51 | own upcall mechanism rather than using /sbin/request-key. |
52 | |||
53 | The two async in-kernel calls may return keys that are still in the process of | ||
54 | being constructed. The two non-async ones will wait for construction to | ||
55 | complete first. | ||
39 | 56 | ||
40 | The userspace interface links the key to a keyring associated with the process | 57 | The userspace interface links the key to a keyring associated with the process |
41 | to prevent the key from going away, and returns the serial number of the key to | 58 | to prevent the key from going away, and returns the serial number of the key to |