13db38ed7SKees Cook=================== 23db38ed7SKees CookKey Request Service 33db38ed7SKees Cook=================== 43db38ed7SKees Cook 53db38ed7SKees CookThe key request service is part of the key retention service (refer to 6c7f66400STom SaegerDocumentation/security/keys/core.rst). This document explains more fully how 73db38ed7SKees Cookthe requesting algorithm works. 83db38ed7SKees Cook 93db38ed7SKees CookThe process starts by either the kernel requesting a service by calling 103db38ed7SKees Cook``request_key*()``:: 113db38ed7SKees Cook 123db38ed7SKees Cook struct key *request_key(const struct key_type *type, 133db38ed7SKees Cook const char *description, 14028db3e2SLinus Torvalds const char *callout_info); 153db38ed7SKees Cook 163db38ed7SKees Cookor:: 173db38ed7SKees Cook 18a58946c1SDavid Howells struct key *request_key_tag(const struct key_type *type, 19a58946c1SDavid Howells const char *description, 20a58946c1SDavid Howells const struct key_tag *domain_tag, 21028db3e2SLinus Torvalds const char *callout_info); 22a58946c1SDavid Howells 23a58946c1SDavid Howellsor:: 24a58946c1SDavid Howells 253db38ed7SKees Cook struct key *request_key_with_auxdata(const struct key_type *type, 263db38ed7SKees Cook const char *description, 27a58946c1SDavid Howells const struct key_tag *domain_tag, 283db38ed7SKees Cook const char *callout_info, 293db38ed7SKees Cook size_t callout_len, 30028db3e2SLinus Torvalds void *aux); 313db38ed7SKees Cook 323db38ed7SKees Cookor:: 333db38ed7SKees Cook 34896f1950SDavid Howells struct key *request_key_rcu(const struct key_type *type, 35a58946c1SDavid Howells const char *description, 36a58946c1SDavid Howells const struct key_tag *domain_tag); 37896f1950SDavid Howells 383db38ed7SKees CookOr by userspace invoking the request_key system call:: 393db38ed7SKees Cook 403db38ed7SKees Cook key_serial_t request_key(const char *type, 413db38ed7SKees Cook const char *description, 423db38ed7SKees Cook const char *callout_info, 433db38ed7SKees Cook key_serial_t dest_keyring); 443db38ed7SKees Cook 453db38ed7SKees CookThe main difference between the access points is that the in-kernel interface 463db38ed7SKees Cookdoes not need to link the key to a keyring to prevent it from being immediately 473db38ed7SKees Cookdestroyed. The kernel interface returns a pointer directly to the key, and 483db38ed7SKees Cookit's up to the caller to destroy the key. 493db38ed7SKees Cook 50a58946c1SDavid HowellsThe request_key_tag() call is like the in-kernel request_key(), except that it 51a58946c1SDavid Howellsalso takes a domain tag that allows keys to be separated by namespace and 52a58946c1SDavid Howellskilled off as a group. 533db38ed7SKees Cook 54a58946c1SDavid HowellsThe request_key_with_auxdata() calls is like the request_key_tag() call, except 55a58946c1SDavid Howellsthat they permit auxiliary data to be passed to the upcaller (the default is 56a58946c1SDavid HowellsNULL). This is only useful for those key types that define their own upcall 57a58946c1SDavid Howellsmechanism rather than using /sbin/request-key. 58a58946c1SDavid Howells 59a58946c1SDavid HowellsThe request_key_rcu() call is like the request_key_tag() call, except that it 60a58946c1SDavid Howellsdoesn't check for keys that are under construction and doesn't attempt to 61a58946c1SDavid Howellsconstruct missing keys. 62896f1950SDavid Howells 633db38ed7SKees CookThe userspace interface links the key to a keyring associated with the process 643db38ed7SKees Cookto prevent the key from going away, and returns the serial number of the key to 653db38ed7SKees Cookthe caller. 663db38ed7SKees Cook 673db38ed7SKees Cook 683db38ed7SKees CookThe following example assumes that the key types involved don't define their 693db38ed7SKees Cookown upcall mechanisms. If they do, then those should be substituted for the 703db38ed7SKees Cookforking and execution of /sbin/request-key. 713db38ed7SKees Cook 723db38ed7SKees Cook 733db38ed7SKees CookThe Process 743db38ed7SKees Cook=========== 753db38ed7SKees Cook 763db38ed7SKees CookA request proceeds in the following manner: 773db38ed7SKees Cook 783db38ed7SKees Cook 1) Process A calls request_key() [the userspace syscall calls the kernel 793db38ed7SKees Cook interface]. 803db38ed7SKees Cook 813db38ed7SKees Cook 2) request_key() searches the process's subscribed keyrings to see if there's 823db38ed7SKees Cook a suitable key there. If there is, it returns the key. If there isn't, 833db38ed7SKees Cook and callout_info is not set, an error is returned. Otherwise the process 843db38ed7SKees Cook proceeds to the next step. 853db38ed7SKees Cook 863db38ed7SKees Cook 3) request_key() sees that A doesn't have the desired key yet, so it creates 873db38ed7SKees Cook two things: 883db38ed7SKees Cook 893db38ed7SKees Cook a) An uninstantiated key U of requested type and description. 903db38ed7SKees Cook 913db38ed7SKees Cook b) An authorisation key V that refers to key U and notes that process A 923db38ed7SKees Cook is the context in which key U should be instantiated and secured, and 933db38ed7SKees Cook from which associated key requests may be satisfied. 943db38ed7SKees Cook 953db38ed7SKees Cook 4) request_key() then forks and executes /sbin/request-key with a new session 963db38ed7SKees Cook keyring that contains a link to auth key V. 973db38ed7SKees Cook 983db38ed7SKees Cook 5) /sbin/request-key assumes the authority associated with key U. 993db38ed7SKees Cook 1003db38ed7SKees Cook 6) /sbin/request-key execs an appropriate program to perform the actual 1013db38ed7SKees Cook instantiation. 1023db38ed7SKees Cook 1033db38ed7SKees Cook 7) The program may want to access another key from A's context (say a 1043db38ed7SKees Cook Kerberos TGT key). It just requests the appropriate key, and the keyring 1053db38ed7SKees Cook search notes that the session keyring has auth key V in its bottom level. 1063db38ed7SKees Cook 1073db38ed7SKees Cook This will permit it to then search the keyrings of process A with the 1083db38ed7SKees Cook UID, GID, groups and security info of process A as if it was process A, 1093db38ed7SKees Cook and come up with key W. 1103db38ed7SKees Cook 1115ea787a7SJonathan Corbet 8) The program then does what it must to get the data with which to 1123db38ed7SKees Cook instantiate key U, using key W as a reference (perhaps it contacts a 1133db38ed7SKees Cook Kerberos server using the TGT) and then instantiates key U. 1143db38ed7SKees Cook 1153db38ed7SKees Cook 9) Upon instantiating key U, auth key V is automatically revoked so that it 1163db38ed7SKees Cook may not be used again. 1173db38ed7SKees Cook 1183db38ed7SKees Cook 10) The program then exits 0 and request_key() deletes key V and returns key 1193db38ed7SKees Cook U to the caller. 1203db38ed7SKees Cook 1213db38ed7SKees CookThis also extends further. If key W (step 7 above) didn't exist, key W would 1223db38ed7SKees Cookbe created uninstantiated, another auth key (X) would be created (as per step 1233db38ed7SKees Cook3) and another copy of /sbin/request-key spawned (as per step 4); but the 1243db38ed7SKees Cookcontext specified by auth key X will still be process A, as it was in auth key 1253db38ed7SKees CookV. 1263db38ed7SKees Cook 1273db38ed7SKees CookThis is because process A's keyrings can't simply be attached to 1283db38ed7SKees Cook/sbin/request-key at the appropriate places because (a) execve will discard two 1293db38ed7SKees Cookof them, and (b) it requires the same UID/GID/Groups all the way through. 1303db38ed7SKees Cook 1313db38ed7SKees Cook 1323db38ed7SKees CookNegative Instantiation And Rejection 1333db38ed7SKees Cook==================================== 1343db38ed7SKees Cook 1353db38ed7SKees CookRather than instantiating a key, it is possible for the possessor of an 1363db38ed7SKees Cookauthorisation key to negatively instantiate a key that's under construction. 1373db38ed7SKees CookThis is a short duration placeholder that causes any attempt at re-requesting 138806654a9SWill Deaconthe key while it exists to fail with error ENOKEY if negated or the specified 1393db38ed7SKees Cookerror if rejected. 1403db38ed7SKees Cook 1413db38ed7SKees CookThis is provided to prevent excessive repeated spawning of /sbin/request-key 1423db38ed7SKees Cookprocesses for a key that will never be obtainable. 1433db38ed7SKees Cook 1443db38ed7SKees CookShould the /sbin/request-key process exit anything other than 0 or die on a 1453db38ed7SKees Cooksignal, the key under construction will be automatically negatively 1463db38ed7SKees Cookinstantiated for a short amount of time. 1473db38ed7SKees Cook 1483db38ed7SKees Cook 1493db38ed7SKees CookThe Search Algorithm 1503db38ed7SKees Cook==================== 1513db38ed7SKees Cook 1523db38ed7SKees CookA search of any particular keyring proceeds in the following fashion: 1533db38ed7SKees Cook 154e59428f7SDavid Howells 1) When the key management code searches for a key (keyring_search_rcu) it 1553db38ed7SKees Cook firstly calls key_permission(SEARCH) on the keyring it's starting with, 1563db38ed7SKees Cook if this denies permission, it doesn't search further. 1573db38ed7SKees Cook 1583db38ed7SKees Cook 2) It considers all the non-keyring keys within that keyring and, if any key 1593db38ed7SKees Cook matches the criteria specified, calls key_permission(SEARCH) on it to see 1603db38ed7SKees Cook if the key is allowed to be found. If it is, that key is returned; if 1613db38ed7SKees Cook not, the search continues, and the error code is retained if of higher 1623db38ed7SKees Cook priority than the one currently set. 1633db38ed7SKees Cook 1643db38ed7SKees Cook 3) It then considers all the keyring-type keys in the keyring it's currently 1653db38ed7SKees Cook searching. It calls key_permission(SEARCH) on each keyring, and if this 1663db38ed7SKees Cook grants permission, it recurses, executing steps (2) and (3) on that 1673db38ed7SKees Cook keyring. 1683db38ed7SKees Cook 1693db38ed7SKees CookThe process stops immediately a valid key is found with permission granted to 1703db38ed7SKees Cookuse it. Any error from a previous match attempt is discarded and the key is 1713db38ed7SKees Cookreturned. 1723db38ed7SKees Cook 1737743c48eSDavid HowellsWhen request_key() is invoked, if CONFIG_KEYS_REQUEST_CACHE=y, a per-task 1747743c48eSDavid Howellsone-key cache is first checked for a match. 1757743c48eSDavid Howells 1763db38ed7SKees CookWhen search_process_keyrings() is invoked, it performs the following searches 1773db38ed7SKees Cookuntil one succeeds: 1783db38ed7SKees Cook 1793db38ed7SKees Cook 1) If extant, the process's thread keyring is searched. 1803db38ed7SKees Cook 1813db38ed7SKees Cook 2) If extant, the process's process keyring is searched. 1823db38ed7SKees Cook 1833db38ed7SKees Cook 3) The process's session keyring is searched. 1843db38ed7SKees Cook 1853db38ed7SKees Cook 4) If the process has assumed the authority associated with a request_key() 1863db38ed7SKees Cook authorisation key then: 1873db38ed7SKees Cook 1883db38ed7SKees Cook a) If extant, the calling process's thread keyring is searched. 1893db38ed7SKees Cook 1903db38ed7SKees Cook b) If extant, the calling process's process keyring is searched. 1913db38ed7SKees Cook 1923db38ed7SKees Cook c) The calling process's session keyring is searched. 1933db38ed7SKees Cook 1943db38ed7SKees CookThe moment one succeeds, all pending errors are discarded and the found key is 1957743c48eSDavid Howellsreturned. If CONFIG_KEYS_REQUEST_CACHE=y, then that key is placed in the 1967743c48eSDavid Howellsper-task cache, displacing the previous key. The cache is cleared on exit or 1977743c48eSDavid Howellsjust prior to resumption of userspace. 1983db38ed7SKees Cook 1993db38ed7SKees CookOnly if all these fail does the whole thing fail with the highest priority 2003db38ed7SKees Cookerror. Note that several errors may have come from LSM. 2013db38ed7SKees Cook 2023db38ed7SKees CookThe error priority is:: 2033db38ed7SKees Cook 2043db38ed7SKees Cook EKEYREVOKED > EKEYEXPIRED > ENOKEY 2053db38ed7SKees Cook 2063db38ed7SKees CookEACCES/EPERM are only returned on a direct search of a specific keyring where 2073db38ed7SKees Cookthe basal keyring does not grant Search permission. 208