€•é‰Œsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)”}”(hhh]”(hŒ pending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ-/translations/zh_CN/security/keys/request-key”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/zh_TW/security/keys/request-key”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/it_IT/security/keys/request-key”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/ja_JP/security/keys/request-key”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/ko_KR/security/keys/request-key”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/pt_BR/security/keys/request-key”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ-/translations/sp_SP/security/keys/request-key”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒKey Request Service”h]”hŒKey Request Service”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³ŒG/var/lib/git/docbuild/linux/Documentation/security/keys/request-key.rst”h´KubhŒ paragraph”“”)”}”(hŒ´The key request service is part of the key retention service (refer to Documentation/security/keys/core.rst). This document explains more fully how the requesting algorithm works.”h]”hŒ´The key request service is part of the key retention service (refer to Documentation/security/keys/core.rst). This document explains more fully how the requesting algorithm works.”…””}”(hhÍh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhÌ)”}”(hŒ\The process starts by either the kernel requesting a service by calling ``request_key*()``::”h]”(hŒHThe process starts by either the kernel requesting a service by calling ”…””}”(hhÛh²hh³Nh´NubhŒliteral”“”)”}”(hŒ``request_key*()``”h]”hŒrequest_key*()”…””}”(hhåh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hãhhÛubhŒ:”…””}”(hhÛh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K hh·h²hubhŒ literal_block”“”)”}”(hŒ˜struct key *request_key(const struct key_type *type, const char *description, const char *callout_info);”h]”hŒ˜struct key *request_key(const struct key_type *type, const char *description, const char *callout_info);”…””}”hhÿsbah}”(h]”h ]”h"]”h$]”h&]”Œ xml:space”Œpreserve”uh1hýh³hÊh´K hh·h²hubhÌ)”}”(hŒor::”h]”hŒor:”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhþ)”}”(hŒâstruct key *request_key_tag(const struct key_type *type, const char *description, const struct key_tag *domain_tag, const char *callout_info);”h]”hŒâstruct key *request_key_tag(const struct key_type *type, const char *description, const struct key_tag *domain_tag, const char *callout_info);”…””}”hjsbah}”(h]”h ]”h"]”h$]”h&]”j juh1hýh³hÊh´Khh·h²hubhÌ)”}”(hŒor::”h]”hŒor:”…””}”(hj+h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhþ)”}”(hXostruct key *request_key_with_auxdata(const struct key_type *type, const char *description, const struct key_tag *domain_tag, const char *callout_info, size_t callout_len, void *aux);”h]”hXostruct key *request_key_with_auxdata(const struct key_type *type, const char *description, const struct key_tag *domain_tag, const char *callout_info, size_t callout_len, void *aux);”…””}”hj9sbah}”(h]”h ]”h"]”h$]”h&]”j juh1hýh³hÊh´Khh·h²hubhÌ)”}”(hŒor::”h]”hŒor:”…””}”(hjGh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K hh·h²hubhþ)”}”(hŒ¬struct key *request_key_rcu(const struct key_type *type, const char *description, const struct key_tag *domain_tag);”h]”hŒ¬struct key *request_key_rcu(const struct key_type *type, const char *description, const struct key_tag *domain_tag);”…””}”hjUsbah}”(h]”h ]”h"]”h$]”h&]”j juh1hýh³hÊh´K"hh·h²hubhÌ)”}”(hŒ6Or by userspace invoking the request_key system call::”h]”hŒ5Or by userspace invoking the request_key system call:”…””}”(hjch²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K&hh·h²hubhþ)”}”(hŒÄkey_serial_t request_key(const char *type, const char *description, const char *callout_info, key_serial_t dest_keyring);”h]”hŒÄkey_serial_t request_key(const char *type, const char *description, const char *callout_info, key_serial_t dest_keyring);”…””}”hjqsbah}”(h]”h ]”h"]”h$]”h&]”j juh1hýh³hÊh´K(hh·h²hubhÌ)”}”(hXThe main difference between the access points is that the in-kernel interface does not need to link the key to a keyring to prevent it from being immediately destroyed. The kernel interface returns a pointer directly to the key, and it's up to the caller to destroy the key.”h]”hXThe main difference between the access points is that the in-kernel interface does not need to link the key to a keyring to prevent it from being immediately destroyed. The kernel interface returns a pointer directly to the key, and it’s up to the caller to destroy the key.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K-hh·h²hubhÌ)”}”(hŒ¯The request_key_tag() call is like the in-kernel request_key(), except that it also takes a domain tag that allows keys to be separated by namespace and killed off as a group.”h]”hŒ¯The request_key_tag() call is like the in-kernel request_key(), except that it also takes a domain tag that allows keys to be separated by namespace and killed off as a group.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K2hh·h²hubhÌ)”}”(hXThe request_key_with_auxdata() calls is like the request_key_tag() call, except that they permit auxiliary data to be passed to the upcaller (the default is NULL). This is only useful for those key types that define their own upcall mechanism rather than using /sbin/request-key.”h]”hXThe request_key_with_auxdata() calls is like the request_key_tag() call, except that they permit auxiliary data to be passed to the upcaller (the default is NULL). This is only useful for those key types that define their own upcall mechanism rather than using /sbin/request-key.”…””}”(hj›h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K6hh·h²hubhÌ)”}”(hŒ¯The request_key_rcu() call is like the request_key_tag() call, except that it doesn't check for keys that are under construction and doesn't attempt to construct missing keys.”h]”hŒ³The request_key_rcu() call is like the request_key_tag() call, except that it doesn’t check for keys that are under construction and doesn’t attempt to construct missing keys.”…””}”(hj©h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K;hh·h²hubhÌ)”}”(hŒªThe userspace interface links the key to a keyring associated with the process to prevent the key from going away, and returns the serial number of the key to the caller.”h]”hŒªThe userspace interface links the key to a keyring associated with the process to prevent the key from going away, and returns the serial number of the key to the caller.”…””}”(hj·h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K?hh·h²hubhÌ)”}”(hŒÅThe following example assumes that the key types involved don't define their own upcall mechanisms. If they do, then those should be substituted for the forking and execution of /sbin/request-key.”h]”hŒÇThe following example assumes that the key types involved don’t define their own upcall mechanisms. If they do, then those should be substituted for the forking and execution of /sbin/request-key.”…””}”(hjÅh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KDhh·h²hubh¶)”}”(hhh]”(h»)”}”(hŒ The Process”h]”hŒ The Process”…””}”(hjÖh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÓh²hh³hÊh´KJubhÌ)”}”(hŒ+A request proceeds in the following manner:”h]”hŒ+A request proceeds in the following manner:”…””}”(hjäh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KLhjÓh²hubhŒ block_quote”“”)”}”(hX1) Process A calls request_key() [the userspace syscall calls the kernel interface]. 2) request_key() searches the process's subscribed keyrings to see if there's a suitable key there. If there is, it returns the key. If there isn't, and callout_info is not set, an error is returned. Otherwise the process proceeds to the next step. 3) request_key() sees that A doesn't have the desired key yet, so it creates two things: a) An uninstantiated key U of requested type and description. b) An authorisation key V that refers to key U and notes that process A is the context in which key U should be instantiated and secured, and from which associated key requests may be satisfied. 4) request_key() then forks and executes /sbin/request-key with a new session keyring that contains a link to auth key V. 5) /sbin/request-key assumes the authority associated with key U. 6) /sbin/request-key execs an appropriate program to perform the actual instantiation. 7) The program may want to access another key from A's context (say a Kerberos TGT key). It just requests the appropriate key, and the keyring search notes that the session keyring has auth key V in its bottom level. This will permit it to then search the keyrings of process A with the UID, GID, groups and security info of process A as if it was process A, and come up with key W. 8) The program then does what it must to get the data with which to instantiate key U, using key W as a reference (perhaps it contacts a Kerberos server using the TGT) and then instantiates key U. 9) Upon instantiating key U, auth key V is automatically revoked so that it may not be used again. 10) The program then exits 0 and request_key() deletes key V and returns key U to the caller. ”h]”hŒenumerated_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hŒRProcess A calls request_key() [the userspace syscall calls the kernel interface]. ”h]”hÌ)”}”(hŒQProcess A calls request_key() [the userspace syscall calls the kernel interface].”h]”hŒQProcess A calls request_key() [the userspace syscall calls the kernel interface].”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KNhjÿubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hŒùrequest_key() searches the process's subscribed keyrings to see if there's a suitable key there. If there is, it returns the key. If there isn't, and callout_info is not set, an error is returned. Otherwise the process proceeds to the next step. ”h]”hÌ)”}”(hŒørequest_key() searches the process's subscribed keyrings to see if there's a suitable key there. If there is, it returns the key. If there isn't, and callout_info is not set, an error is returned. Otherwise the process proceeds to the next step.”h]”hŒþrequest_key() searches the process’s subscribed keyrings to see if there’s a suitable key there. If there is, it returns the key. If there isn’t, and callout_info is not set, an error is returned. Otherwise the process proceeds to the next step.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KQhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hXcrequest_key() sees that A doesn't have the desired key yet, so it creates two things: a) An uninstantiated key U of requested type and description. b) An authorisation key V that refers to key U and notes that process A is the context in which key U should be instantiated and secured, and from which associated key requests may be satisfied. ”h]”(hÌ)”}”(hŒUrequest_key() sees that A doesn't have the desired key yet, so it creates two things:”h]”hŒWrequest_key() sees that A doesn’t have the desired key yet, so it creates two things:”…””}”(hj3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KVhj/ubjó)”}”(hXa) An uninstantiated key U of requested type and description. b) An authorisation key V that refers to key U and notes that process A is the context in which key U should be instantiated and secured, and from which associated key requests may be satisfied. ”h]”jù)”}”(hhh]”(jþ)”}”(hŒ;An uninstantiated key U of requested type and description. ”h]”hÌ)”}”(hŒ:An uninstantiated key U of requested type and description.”h]”hŒ:An uninstantiated key U of requested type and description.”…””}”(hjLh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KYhjHubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjEubjþ)”}”(hŒÀAn authorisation key V that refers to key U and notes that process A is the context in which key U should be instantiated and secured, and from which associated key requests may be satisfied. ”h]”hÌ)”}”(hŒ¿An authorisation key V that refers to key U and notes that process A is the context in which key U should be instantiated and secured, and from which associated key requests may be satisfied.”h]”hŒ¿An authorisation key V that refers to key U and notes that process A is the context in which key U should be instantiated and secured, and from which associated key requests may be satisfied.”…””}”(hjdh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K[hj`ubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjEubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œ loweralpha”Œprefix”hŒsuffix”Œ)”uh1jøhjAubah}”(h]”h ]”h"]”h$]”h&]”uh1jòh³hÊh´KYhj/ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hŒwrequest_key() then forks and executes /sbin/request-key with a new session keyring that contains a link to auth key V. ”h]”hÌ)”}”(hŒvrequest_key() then forks and executes /sbin/request-key with a new session keyring that contains a link to auth key V.”h]”hŒvrequest_key() then forks and executes /sbin/request-key with a new session keyring that contains a link to auth key V.”…””}”(hj“h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K_hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hŒ?/sbin/request-key assumes the authority associated with key U. ”h]”hÌ)”}”(hŒ>/sbin/request-key assumes the authority associated with key U.”h]”hŒ>/sbin/request-key assumes the authority associated with key U.”…””}”(hj«h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kbhj§ubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hŒT/sbin/request-key execs an appropriate program to perform the actual instantiation. ”h]”hÌ)”}”(hŒS/sbin/request-key execs an appropriate program to perform the actual instantiation.”h]”hŒS/sbin/request-key execs an appropriate program to perform the actual instantiation.”…””}”(hjÃh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kdhj¿ubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hX~The program may want to access another key from A's context (say a Kerberos TGT key). It just requests the appropriate key, and the keyring search notes that the session keyring has auth key V in its bottom level. This will permit it to then search the keyrings of process A with the UID, GID, groups and security info of process A as if it was process A, and come up with key W. ”h]”(hÌ)”}”(hŒÖThe program may want to access another key from A's context (say a Kerberos TGT key). It just requests the appropriate key, and the keyring search notes that the session keyring has auth key V in its bottom level.”h]”hŒØThe program may want to access another key from A’s context (say a Kerberos TGT key). It just requests the appropriate key, and the keyring search notes that the session keyring has auth key V in its bottom level.”…””}”(hjÛh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kghj×ubhÌ)”}”(hŒ¥This will permit it to then search the keyrings of process A with the UID, GID, groups and security info of process A as if it was process A, and come up with key W.”h]”hŒ¥This will permit it to then search the keyrings of process A with the UID, GID, groups and security info of process A as if it was process A, and come up with key W.”…””}”(hjéh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kkhj×ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hŒÂThe program then does what it must to get the data with which to instantiate key U, using key W as a reference (perhaps it contacts a Kerberos server using the TGT) and then instantiates key U. ”h]”hÌ)”}”(hŒÁThe program then does what it must to get the data with which to instantiate key U, using key W as a reference (perhaps it contacts a Kerberos server using the TGT) and then instantiates key U.”h]”hŒÁThe program then does what it must to get the data with which to instantiate key U, using key W as a reference (perhaps it contacts a Kerberos server using the TGT) and then instantiates key U.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kohjýubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hŒ`Upon instantiating key U, auth key V is automatically revoked so that it may not be used again. ”h]”hÌ)”}”(hŒ_Upon instantiating key U, auth key V is automatically revoked so that it may not be used again.”h]”hŒ_Upon instantiating key U, auth key V is automatically revoked so that it may not be used again.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kshjubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubjþ)”}”(hŒZThe program then exits 0 and request_key() deletes key V and returns key U to the caller. ”h]”hÌ)”}”(hŒYThe program then exits 0 and request_key() deletes key V and returns key U to the caller.”h]”hŒYThe program then exits 0 and request_key() deletes key V and returns key U to the caller.”…””}”(hj1h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kvhj-ubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjúubeh}”(h]”h ]”h"]”h$]”h&]”j~Œarabic”j€hjj‚uh1jøhjôubah}”(h]”h ]”h"]”h$]”h&]”uh1jòh³hÊh´KNhjÓh²hubhÌ)”}”(hX7This also extends further. If key W (step 7 above) didn't exist, key W would be created uninstantiated, another auth key (X) would be created (as per step 3) and another copy of /sbin/request-key spawned (as per step 4); but the context specified by auth key X will still be process A, as it was in auth key V.”h]”hX9This also extends further. If key W (step 7 above) didn’t exist, key W would be created uninstantiated, another auth key (X) would be created (as per step 3) and another copy of /sbin/request-key spawned (as per step 4); but the context specified by auth key X will still be process A, as it was in auth key V.”…””}”(hjRh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KyhjÓh²hubhÌ)”}”(hŒÚThis is because process A's keyrings can't simply be attached to /sbin/request-key at the appropriate places because (a) execve will discard two of them, and (b) it requires the same UID/GID/Groups all the way through.”h]”hŒÞThis is because process A’s keyrings can’t simply be attached to /sbin/request-key at the appropriate places because (a) execve will discard two of them, and (b) it requires the same UID/GID/Groups all the way through.”…””}”(hj`h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KhjÓh²hubeh}”(h]”Œ the-process”ah ]”h"]”Œ the process”ah$]”h&]”uh1hµhh·h²hh³hÊh´KJubh¶)”}”(hhh]”(h»)”}”(hŒ$Negative Instantiation And Rejection”h]”hŒ$Negative Instantiation And Rejection”…””}”(hjyh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjvh²hh³hÊh´K…ubhÌ)”}”(hXCRather than instantiating a key, it is possible for the possessor of an authorisation key to negatively instantiate a key that's under construction. This is a short duration placeholder that causes any attempt at re-requesting the key while it exists to fail with error ENOKEY if negated or the specified error if rejected.”h]”hXERather than instantiating a key, it is possible for the possessor of an authorisation key to negatively instantiate a key that’s under construction. This is a short duration placeholder that causes any attempt at re-requesting the key while it exists to fail with error ENOKEY if negated or the specified error if rejected.”…””}”(hj‡h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K‡hjvh²hubhÌ)”}”(hŒThis is provided to prevent excessive repeated spawning of /sbin/request-key processes for a key that will never be obtainable.”h]”hŒThis is provided to prevent excessive repeated spawning of /sbin/request-key processes for a key that will never be obtainable.”…””}”(hj•h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khjvh²hubhÌ)”}”(hŒ¸Should the /sbin/request-key process exit anything other than 0 or die on a signal, the key under construction will be automatically negatively instantiated for a short amount of time.”h]”hŒ¸Should the /sbin/request-key process exit anything other than 0 or die on a signal, the key under construction will be automatically negatively instantiated for a short amount of time.”…””}”(hj£h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khjvh²hubeh}”(h]”Œ$negative-instantiation-and-rejection”ah ]”h"]”Œ$negative instantiation and rejection”ah$]”h&]”uh1hµhh·h²hh³hÊh´K…ubh¶)”}”(hhh]”(h»)”}”(hŒThe Search Algorithm”h]”hŒThe Search Algorithm”…””}”(hj¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj¹h²hh³hÊh´K–ubhÌ)”}”(hŒEA search of any particular keyring proceeds in the following fashion:”h]”hŒEA search of any particular keyring proceeds in the following fashion:”…””}”(hjÊh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K˜hj¹h²hubjó)”}”(hX1) When the key management code searches for a key (keyring_search_rcu) it firstly calls key_permission(SEARCH) on the keyring it's starting with, if this denies permission, it doesn't search further. 2) It considers all the non-keyring keys within that keyring and, if any key matches the criteria specified, calls key_permission(SEARCH) on it to see if the key is allowed to be found. If it is, that key is returned; if not, the search continues, and the error code is retained if of higher priority than the one currently set. 3) It then considers all the keyring-type keys in the keyring it's currently searching. It calls key_permission(SEARCH) on each keyring, and if this grants permission, it recurses, executing steps (2) and (3) on that keyring. ”h]”jù)”}”(hhh]”(jþ)”}”(hŒÆWhen the key management code searches for a key (keyring_search_rcu) it firstly calls key_permission(SEARCH) on the keyring it's starting with, if this denies permission, it doesn't search further. ”h]”hÌ)”}”(hŒÅWhen the key management code searches for a key (keyring_search_rcu) it firstly calls key_permission(SEARCH) on the keyring it's starting with, if this denies permission, it doesn't search further.”h]”hŒÉWhen the key management code searches for a key (keyring_search_rcu) it firstly calls key_permission(SEARCH) on the keyring it’s starting with, if this denies permission, it doesn’t search further.”…””}”(hjãh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kšhjßubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjÜubjþ)”}”(hXGIt considers all the non-keyring keys within that keyring and, if any key matches the criteria specified, calls key_permission(SEARCH) on it to see if the key is allowed to be found. If it is, that key is returned; if not, the search continues, and the error code is retained if of higher priority than the one currently set. ”h]”hÌ)”}”(hXFIt considers all the non-keyring keys within that keyring and, if any key matches the criteria specified, calls key_permission(SEARCH) on it to see if the key is allowed to be found. If it is, that key is returned; if not, the search continues, and the error code is retained if of higher priority than the one currently set.”h]”hXFIt considers all the non-keyring keys within that keyring and, if any key matches the criteria specified, calls key_permission(SEARCH) on it to see if the key is allowed to be found. If it is, that key is returned; if not, the search continues, and the error code is retained if of higher priority than the one currently set.”…””}”(hjûh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kžhj÷ubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjÜubjþ)”}”(hŒàIt then considers all the keyring-type keys in the keyring it's currently searching. It calls key_permission(SEARCH) on each keyring, and if this grants permission, it recurses, executing steps (2) and (3) on that keyring. ”h]”hÌ)”}”(hŒßIt then considers all the keyring-type keys in the keyring it's currently searching. It calls key_permission(SEARCH) on each keyring, and if this grants permission, it recurses, executing steps (2) and (3) on that keyring.”h]”hŒáIt then considers all the keyring-type keys in the keyring it’s currently searching. It calls key_permission(SEARCH) on each keyring, and if this grants permission, it recurses, executing steps (2) and (3) on that keyring.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K¤hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjÜubeh}”(h]”h ]”h"]”h$]”h&]”j~jKj€hjj‚uh1jøhjØubah}”(h]”h ]”h"]”h$]”h&]”uh1jòh³hÊh´Kšhj¹h²hubhÌ)”}”(hŒ¤The process stops immediately a valid key is found with permission granted to use it. Any error from a previous match attempt is discarded and the key is returned.”h]”hŒ¤The process stops immediately a valid key is found with permission granted to use it. Any error from a previous match attempt is discarded and the key is returned.”…””}”(hj3h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K©hj¹h²hubhÌ)”}”(hŒuWhen request_key() is invoked, if CONFIG_KEYS_REQUEST_CACHE=y, a per-task one-key cache is first checked for a match.”h]”hŒuWhen request_key() is invoked, if CONFIG_KEYS_REQUEST_CACHE=y, a per-task one-key cache is first checked for a match.”…””}”(hjAh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K­hj¹h²hubhÌ)”}”(hŒaWhen search_process_keyrings() is invoked, it performs the following searches until one succeeds:”h]”hŒaWhen search_process_keyrings() is invoked, it performs the following searches until one succeeds:”…””}”(hjOh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K°hj¹h²hubjó)”}”(hXÏ1) If extant, the process's thread keyring is searched. 2) If extant, the process's process keyring is searched. 3) The process's session keyring is searched. 4) If the process has assumed the authority associated with a request_key() authorisation key then: a) If extant, the calling process's thread keyring is searched. b) If extant, the calling process's process keyring is searched. c) The calling process's session keyring is searched. ”h]”jù)”}”(hhh]”(jþ)”}”(hŒ5If extant, the process's thread keyring is searched. ”h]”hÌ)”}”(hŒ4If extant, the process's thread keyring is searched.”h]”hŒ6If extant, the process’s thread keyring is searched.”…””}”(hjhh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K³hjdubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjaubjþ)”}”(hŒ6If extant, the process's process keyring is searched. ”h]”hÌ)”}”(hŒ5If extant, the process's process keyring is searched.”h]”hŒ7If extant, the process’s process keyring is searched.”…””}”(hj€h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kµhj|ubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjaubjþ)”}”(hŒ+The process's session keyring is searched. ”h]”hÌ)”}”(hŒ*The process's session keyring is searched.”h]”hŒ,The process’s session keyring is searched.”…””}”(hj˜h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K·hj”ubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjaubjþ)”}”(hXIf the process has assumed the authority associated with a request_key() authorisation key then: a) If extant, the calling process's thread keyring is searched. b) If extant, the calling process's process keyring is searched. c) The calling process's session keyring is searched. ”h]”(hÌ)”}”(hŒ`If the process has assumed the authority associated with a request_key() authorisation key then:”h]”hŒ`If the process has assumed the authority associated with a request_key() authorisation key then:”…””}”(hj°h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K¹hj¬ubjó)”}”(hŒ¹a) If extant, the calling process's thread keyring is searched. b) If extant, the calling process's process keyring is searched. c) The calling process's session keyring is searched. ”h]”jù)”}”(hhh]”(jþ)”}”(hŒ=If extant, the calling process's thread keyring is searched. ”h]”hÌ)”}”(hŒIf extant, the calling process’s thread keyring is searched.”…””}”(hjÉh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K¼hjÅubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjÂubjþ)”}”(hŒ>If extant, the calling process's process keyring is searched. ”h]”hÌ)”}”(hŒ=If extant, the calling process's process keyring is searched.”h]”hŒ?If extant, the calling process’s process keyring is searched.”…””}”(hjáh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K¾hjÝubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjÂubjþ)”}”(hŒ3The calling process's session keyring is searched. ”h]”hÌ)”}”(hŒ2The calling process's session keyring is searched.”h]”hŒ4The calling process’s session keyring is searched.”…””}”(hjùh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÀhjõubah}”(h]”h ]”h"]”h$]”h&]”uh1jýhjÂubeh}”(h]”h ]”h"]”h$]”h&]”j~jj€hjj‚uh1jøhj¾ubah}”(h]”h ]”h"]”h$]”h&]”uh1jòh³hÊh´K¼hj¬ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jýhjaubeh}”(h]”h ]”h"]”h$]”h&]”j~jKj€hjj‚uh1jøhj]ubah}”(h]”h ]”h"]”h$]”h&]”uh1jòh³hÊh´K³hj¹h²hubhÌ)”}”(hX The moment one succeeds, all pending errors are discarded and the found key is returned. If CONFIG_KEYS_REQUEST_CACHE=y, then that key is placed in the per-task cache, displacing the previous key. The cache is cleared on exit or just prior to resumption of userspace.”h]”hX The moment one succeeds, all pending errors are discarded and the found key is returned. If CONFIG_KEYS_REQUEST_CACHE=y, then that key is placed in the per-task cache, displacing the previous key. The cache is cleared on exit or just prior to resumption of userspace.”…””}”(hj+h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÂhj¹h²hubhÌ)”}”(hŒƒOnly if all these fail does the whole thing fail with the highest priority error. Note that several errors may have come from LSM.”h]”hŒƒOnly if all these fail does the whole thing fail with the highest priority error. Note that several errors may have come from LSM.”…””}”(hj9h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÇhj¹h²hubhÌ)”}”(hŒThe error priority is::”h]”hŒThe error priority is:”…””}”(hjGh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÊhj¹h²hubhþ)”}”(hŒ"EKEYREVOKED > EKEYEXPIRED > ENOKEY”h]”hŒ"EKEYREVOKED > EKEYEXPIRED > ENOKEY”…””}”hjUsbah}”(h]”h ]”h"]”h$]”h&]”j juh1hýh³hÊh´KÌhj¹h²hubhÌ)”}”(hŒEACCES/EPERM are only returned on a direct search of a specific keyring where the basal keyring does not grant Search permission.”h]”hŒEACCES/EPERM are only returned on a direct search of a specific keyring where the basal keyring does not grant Search permission.”…””}”(hjch²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÎhj¹h²hubeh}”(h]”Œthe-search-algorithm”ah ]”h"]”Œthe search algorithm”ah$]”h&]”uh1hµhh·h²hh³hÊh´K–ubeh}”(h]”Œkey-request-service”ah ]”h"]”Œkey request service”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒ current_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ generator”NŒ datestamp”NŒ source_link”NŒ source_url”NŒ toc_backlinks”Œentry”Œfootnote_backlinks”KŒ sectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒ strip_classes”NŒ report_level”KŒ halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ traceback”ˆŒinput_encoding”Œ utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j¤Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ id_prefix”hŒauto_id_prefix”Œid”Œ dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ _destination”NŒ _config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒ raw_enabled”KŒline_length_limit”M'Œpep_references”NŒ pep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒ rfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œ smart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ docinfo_xform”KŒsectsubtitle_xform”‰Œ image_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j~j{jsjpj¶j³jvjsuŒ nametypes”}”(j~‰js‰j¶‰jv‰uh}”(j{h·jpjÓj³jvjsj¹uŒ footnote_refs”}”Œ citation_refs”}”Œ autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ footnotes”]”Œ citations”]”Œautofootnote_start”KŒsymbol_footnote_start”KŒ id_counter”Œ collections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œ transformer”NŒ include_log”]”Œ decoration”Nh²hub.