var searchIndex = {};
searchIndex["keyutils"] = {"doc":"TODO","items":[[3,"Keyring","keyutils","Representation of a kernel keyring.",null,null],[3,"Key","","",null,null],[3,"KeyDescription","","Structure representing the metadata about a key or keyring.",null,null],[12,"type_","","The type of the key.",0,null],[12,"uid","","The user owner of the key.",0,null],[12,"gid","","The group owner of the key.",0,null],[12,"perms","","The permissions of the key.",0,null],[12,"description","","The plaintext description of the key.",0,null],[3,"KeyManager","","TODO",null,null],[3,"KeyringPermission","","",null,null],[4,"SpecialKeyring","","Special keyrings predefined for a process.",null,null],[13,"ThreadKeyring","","A thread-specific keyring.",1,null],[13,"ProcessKeyring","","A process-specific keyring.",1,null],[13,"SessionKeyring","","A session-specific keyring.",1,null],[13,"UserKeyring","","TODO",1,null],[13,"UserSessionKeyring","","TODO",1,null],[13,"GroupKeyring","","TODO",1,null],[4,"DefaultKeyring","","An enumeration for the keyrings which may be set as the default.",null,null],[13,"NoChange","","TODO",2,null],[13,"ThreadKeyring","","TODO",2,null],[13,"ProcessKeyring","","TODO",2,null],[13,"SessionKeyring","","TODO",2,null],[13,"UserKeyring","","TODO",2,null],[13,"UserSessionKeyring","","TODO",2,null],[13,"GroupKeyring","","TODO",2,null],[13,"DefaultKeyring","","TODO",2,null],[11,"set_default","","Set the default keyring to use when implicit requests on the current thread. Returns the\nold default keyring.",3,{"inputs":[{"name":"defaultkeyring"}],"output":{"name":"result"}}],[11,"request","","Requests a keyring with the given description by searching the thread, process, and session\nkeyrings.",3,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"request_with_fallback","","Requests a keyring with the given description by searching the thread, process, and session\nkeyrings. If it is not found, the `info` string will be handed off to `/sbin/request-key`\nto generate the key.",3,{"inputs":[{"name":"str"},{"name":"str"}],"output":{"name":"result"}}],[11,"attach","","Attach to a special keyring. Fails if the keyring does not already exist.",3,{"inputs":[{"name":"specialkeyring"}],"output":{"name":"result"}}],[11,"attach_or_create","","Attach to a special keyring or create it if it does not exist.",3,{"inputs":[{"name":"specialkeyring"}],"output":{"name":"result"}}],[11,"join_anonymous_session","","Create a new anonymous keyring and set it as the session keyring.",3,{"inputs":[],"output":{"name":"result"}}],[11,"join_session","","If a keyring named `name` exists, attach it as the session keyring (requires the `search`\npermission). If a keyring does not exist, create it and attach it as the session keyring.",3,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"clear","","Clears the contents of the keyring. Requires `write` permission on the keyring.",3,null],[11,"link_key","","Adds a link to `key` to the keyring. Any link to an existing key with the same description\nis removed. Requires `write` permission on the keyring and `link` permission on the key.",3,null],[11,"unlink_key","","Removes the link to `key` from the keyring. Requires `write` permission on the keyring.",3,null],[11,"link_keyring","","Adds a link to `keyring` to the keyring. Any link to an existing keyring with the same\ndescription is removed. Requires `write` permission on the current keyring and `link`\npermission on the linked keyring.",3,null],[11,"unlink_keyring","","Removes the link to `keyring` from the keyring. Requires `write` permission on the keyring.",3,null],[11,"search_for_key","","Recursively search the keyring for a key with the matching description. If it is found, it\nis attached to the keyring (if `write` permission to the keyring and `link` permission on\nthe key exist) and return it. Requires the `search` permission on the keyring. Any children\nkeyrings without the `search` permission are ignored.",3,null],[11,"search_for_keyring","","Recursively search the keyring for a keyring with the matching description. If it is found,\nit is attached to the keyring (if `write` permission to the keyring and `link` permission\non the found keyring exist) and return it. Requires the `search` permission on the keyring.\nAny children keyrings without the `search` permission are ignored.",3,null],[11,"read","","Return all immediate children of the keyring. Requires `read` permission on the keyring.",3,null],[11,"attach_persistent","","Attach the persistent keyring for the current user to the current keyring. If one does not\nexist, it will be created. Requires `write` permission on the keyring.",3,null],[11,"add_key","","Adds a key to the keyring. If a key with the same description already exists and has the\n`update` permission, it will be updated, otherwise the link to the old key will be removed.\nRequires `write` permission.",3,null],[11,"add_keyring","","Adds a keyring to the current keyring. If a keyring with the same description already, the\nlink to the old keyring will be removed. Requires `write` permission on the keyring.",3,null],[11,"request_key","","Requests a keyring with the given description by searching the thread, process, and session\nkeyrings. If it is found, it is attached to the keyring.",3,null],[11,"request_keyring","","Requests a keyring with the given description by searching the thread, process, and session\nkeyrings. If it is found, it is attached to the keyring.",3,null],[11,"request_key_with_fallback","","Requests a key with the given description by searching the thread, process, and session\nkeyrings. If it is not found, the `info` string will be handed off to `/sbin/request-key`\nto generate the key. If found, it will be attached to the current keyring. Requires `write`\npermission to the keyring.",3,null],[11,"request_keyring_with_fallback","","Requests a keyring with the given description by searching the thread, process, and session\nkeyrings. If it is not found, the `info` string will be handed off to `/sbin/request-key`\nto generate the key. If found, it will be attached to the current keyring. Requires `write`\npermission to the keyring.",3,null],[11,"revoke","","Revokes the keyring. Requires `write` permission on the keyring.",3,null],[11,"chown","","Change the user which owns the keyring. Requires the `setattr` permission on the keyring\nand the SysAdmin capability to change it to anything other than the current user.",3,null],[11,"chgrp","","Change the group which owns the keyring. Requires the `setattr` permission on the keyring\nand the SysAdmin capability to change it to anything other than a group of which the\ncurrent user is a member.",3,null],[11,"set_permissions","","Set the permissions on the keyring. Requires the `setattr` permission on the keyring and\nthe SysAdmin capability if the current user does not own the keyring.",3,null],[11,"description","","Retrieve metadata about the keyring.",3,null],[11,"set_timeout","","Set an expiration timer on the keyring to `timeout` seconds in the future. A timeout of 0\nmeans "no expiration". Requires the `setattr` permission on the keyring.",3,null],[11,"security","","The security context of the keyring. Depends on the security manager loaded into the kernel\n(e.g., SELinux or AppArmor).",3,null],[11,"invalidate","","Invalidates the keyring and schedules it for removal. Requires the `search` permission on\nthe keyring.",3,null],[11,"request_key_auth_key","","Requests a key with the given description by searching the thread, process, and session\nkeyrings.",4,{"inputs":[{"name":"bool"}],"output":{"name":"result"}}],[11,"request","","Requests a key with the given description by searching the thread, process, and session\nkeyrings.",4,{"inputs":[{"name":"str"}],"output":{"name":"result"}}],[11,"request_with_fallback","","Requests a key with the given description by searching the thread, process, and session\nkeyrings. If it is not found, the `info` string will be handed off to `/sbin/request-key`\nto generate the key.",4,{"inputs":[{"name":"str"},{"name":"str"}],"output":{"name":"result"}}],[11,"update","","Update the payload in the key.",4,null],[11,"revoke","","Revokes the key. Requires `write` permission on the key.",4,null],[11,"chown","","Change the user which owns the key. Requires the `setattr` permission on the key and the\nSysAdmin capability to change it to anything other than the current user.",4,null],[11,"chgrp","","Change the group which owns the key. Requires the `setattr` permission on the key and the\nSysAdmin capability to change it to anything other than a group of which the current user\nis a member.",4,null],[11,"set_permissions","","Set the permissions on the key. Requires the `setattr` permission on the key and the\nSysAdmin capability if the current user does not own the key.",4,null],[11,"description","","Retrieve metadata about the key.",4,null],[11,"read","","",4,null],[11,"set_timeout","","Set an expiration timer on the key to `timeout` seconds in the future. A timeout of 0 means\n"no expiration". Requires the `setattr` permission on the key.",4,null],[11,"security","","The security context of the key. Depends on the security manager loaded into the kernel\n(e.g., SELinux or AppArmor).",4,null],[11,"invalidate","","Invalidates the key and schedules it for removal. Requires the `search` permission on the\nkey.",4,null],[11,"manage","","TODO",4,null],[11,"instantiate","","TODO",5,null],[11,"reject","","TODO",5,null],[11,"negate","","TODO",5,null],[11,"serial","","Retrieve the serial number for the special keyring.",1,null],[11,"serial","","Retrieve the serial number for the default keyring.",2,null],[11,"from","","",2,{"inputs":[{"name":"i32"}],"output":{"name":"defaultkeyring"}}],[11,"hash","","",6,null],[11,"cmp","","",6,null],[11,"partial_cmp","","",6,null],[11,"lt","","",6,null],[11,"le","","",6,null],[11,"gt","","",6,null],[11,"ge","","",6,null],[11,"clone","","",6,null],[11,"eq","","",6,null],[11,"ne","","",6,null],[11,"fmt","","",6,null],[11,"empty","","Returns an empty set of flags.",6,{"inputs":[],"output":{"name":"keyringpermission"}}],[11,"all","","Returns the set containing all flags.",6,{"inputs":[],"output":{"name":"keyringpermission"}}],[11,"bits","","Returns the raw value of the flags currently stored.",6,null],[11,"from_bits","","Convert from underlying bit representation, unless that\nrepresentation contains bits that do not correspond to a flag.",6,{"inputs":[{"name":"key_perm_t"}],"output":{"name":"option"}}],[11,"from_bits_truncate","","Convert from underlying bit representation, dropping any bits\nthat do not correspond to flags.",6,{"inputs":[{"name":"key_perm_t"}],"output":{"name":"keyringpermission"}}],[11,"is_empty","","Returns `true` if no flags are currently stored.",6,null],[11,"is_all","","Returns `true` if all flags are currently set.",6,null],[11,"intersects","","Returns `true` if there are flags common to both `self` and `other`.",6,null],[11,"contains","","Returns `true` all of the flags in `other` are contained within `self`.",6,null],[11,"insert","","Inserts the specified flags in-place.",6,null],[11,"remove","","Removes the specified flags in-place.",6,null],[11,"toggle","","Toggles the specified flags in-place.",6,null],[11,"bitor","","Returns the union of the two sets of flags.",6,null],[11,"bitxor","","Returns the left flags, but with all the right flags toggled.",6,null],[11,"bitand","","Returns the intersection between the two sets of flags.",6,null],[11,"sub","","Returns the set difference of the two sets of flags.",6,null],[11,"not","","Returns the complement of this set of flags.",6,null],[11,"from_iter","","",6,{"inputs":[{"name":"t"}],"output":{"name":"keyringpermission"}}],[6,"Error","","",null,null],[6,"Result","","",null,null],[6,"KeyringSerial","","The kernel type for representing a keyring (or key).",null,null],[6,"KeyringDefaultSerial","","The kernel type for representing a default keyring.",null,null],[6,"KeyPermissions","","The kernel type for representing a keyring's (or key's) permission.",null,null],[17,"POSSESSOR_VIEW","","",null,null],[17,"POSSESSOR_READ","","",null,null],[17,"POSSESSOR_WRITE","","",null,null],[17,"POSSESSOR_SEARCH","","",null,null],[17,"POSSESSOR_LINK","","",null,null],[17,"POSSESSOR_SET_ATTRIBUTE","","",null,null],[17,"POSSESSOR_ALL","","",null,null],[17,"USER_VIEW","","",null,null],[17,"USER_READ","","",null,null],[17,"USER_WRITE","","",null,null],[17,"USER_SEARCH","","",null,null],[17,"USER_LINK","","",null,null],[17,"USER_SET_ATTRIBUTE","","",null,null],[17,"USER_ALL","","",null,null],[17,"GROUP_VIEW","","",null,null],[17,"GROUP_READ","","",null,null],[17,"GROUP_WRITE","","",null,null],[17,"GROUP_SEARCH","","",null,null],[17,"GROUP_LINK","","",null,null],[17,"GROUP_SET_ATTRIBUTE","","",null,null],[17,"GROUP_ALL","","",null,null],[17,"OTHER_VIEW","","",null,null],[17,"OTHER_READ","","",null,null],[17,"OTHER_WRITE","","",null,null],[17,"OTHER_SEARCH","","",null,null],[17,"OTHER_LINK","","",null,null],[17,"OTHER_SET_ATTRIBUTE","","",null,null],[17,"OTHER_ALL","","",null,null]],"paths":[[3,"KeyDescription"],[4,"SpecialKeyring"],[4,"DefaultKeyring"],[3,"Keyring"],[3,"Key"],[3,"KeyManager"],[3,"KeyringPermission"]]};
initSearch(searchIndex);