windows-acl 0.3.0

Rust crate to simplify Windows ACL operations
Documentation
1
2
3
var searchIndex = {};
searchIndex["windows_acl"] = {"doc":"`windows-acl` is a Rust library to simplify Windows ACL operations.","items":[[0,"acl","windows_acl","Contains the ACL introspection and manipulation functionality",null,null],[3,"ACLEntry","windows_acl::acl","`ACLEntry` represents a single access control entry in an access control list",null,null],[12,"index","","The index of the current entry in the raw access control list",0,null],[12,"entry_type","","The entry's type",0,null],[12,"entry_size","","The calculated size of the current access control entry",0,null],[12,"size","","See `AceSize` in ACE_HEADER",0,null],[12,"flags","","See `AceFlags` in ACE_HEADER",0,null],[12,"mask","","See ACCESS_MASK",0,null],[12,"sid","","The target entity's raw SID",0,null],[12,"string_sid","","The target entity's SID in string representation",0,null],[3,"ACL","","`ACL` represents the access control list (discretionary or oth discretionary/system) for a named object",null,null],[4,"ObjectType","","This enum is almost a direct mapping with the values described in SE_OBJECT_TYPE",null,null],[13,"Unknown","","",1,null],[13,"FileObject","","",1,null],[13,"ServiceObject","","",1,null],[13,"PrinterObject","","",1,null],[13,"RegistryKey","","",1,null],[13,"LmShare","","",1,null],[13,"KernelObject","","",1,null],[13,"WindowObject","","",1,null],[13,"DsObject","","",1,null],[13,"DsObjectAll","","",1,null],[13,"ProviderDefinedObject","","",1,null],[13,"WmiGuidObject","","",1,null],[13,"RegistryWow6432Key","","",1,null],[4,"AceType","","This enum is a almost direct mapping with the values described under `AceType` in ACE_HEADER",null,null],[13,"Unknown","","",2,null],[13,"AccessAllow","","",2,null],[13,"AccessAllowCallback","","",2,null],[13,"AccessAllowObject","","",2,null],[13,"AccessAllowCallbackObject","","",2,null],[13,"AccessDeny","","",2,null],[13,"AccessDenyCallback","","",2,null],[13,"AccessDenyObject","","",2,null],[13,"AccessDenyCallbackObject","","",2,null],[13,"SystemAudit","","",2,null],[13,"SystemAuditCallback","","",2,null],[13,"SystemAuditObject","","",2,null],[13,"SystemAuditCallbackObject","","",2,null],[13,"SystemMandatoryLabel","","",2,null],[13,"SystemResourceAttribute","","",2,null],[11,"clone","","",1,{"inputs":[{"name":"self"}],"output":{"name":"objecttype"}}],[11,"fmt","","",1,{"inputs":[{"name":"self"},{"name":"formatter"}],"output":{"name":"result"}}],[11,"eq","","",1,{"inputs":[{"name":"self"},{"name":"objecttype"}],"output":{"name":"bool"}}],[11,"from","","",1,{"inputs":[{"name":"se_object_type"}],"output":{"name":"self"}}],[11,"clone","","",2,{"inputs":[{"name":"self"}],"output":{"name":"acetype"}}],[11,"fmt","","",2,{"inputs":[{"name":"self"},{"name":"formatter"}],"output":{"name":"result"}}],[11,"eq","","",2,{"inputs":[{"name":"self"},{"name":"acetype"}],"output":{"name":"bool"}}],[11,"fmt","","",3,{"inputs":[{"name":"self"},{"name":"formatter"}],"output":{"name":"result"}}],[11,"new","","Returns an `ACLEntry` object with default values.",0,{"inputs":[],"output":{"name":"aclentry"}}],[11,"fmt","","",1,{"inputs":[{"name":"self"},{"name":"formatter"}],"output":{"name":"result"}}],[11,"fmt","","",2,{"inputs":[{"name":"self"},{"name":"formatter"}],"output":{"name":"result"}}],[11,"from_path","","Creates an `ACL` object from a specified named object path.",3,{"inputs":[{"name":"str"},{"name":"se_object_type"},{"name":"bool"}],"output":{"generics":["acl","dword"],"name":"result"}}],[11,"from_file_path","","Creates an `ACL` object from a specified file path.",3,{"inputs":[{"name":"str"},{"name":"bool"}],"output":{"generics":["acl","dword"],"name":"result"}}],[11,"from_object_path","","Creates an `ACL` object from a specified kernel object path.",3,{"inputs":[{"name":"str"},{"name":"bool"}],"output":{"generics":["acl","dword"],"name":"result"}}],[11,"from_registry_path","","Creates an `ACL` object from a specified registry path.",3,{"inputs":[{"name":"str"},{"name":"bool"},{"name":"bool"}],"output":{"generics":["acl","dword"],"name":"result"}}],[11,"object_type","","Returns the `ObjectType` of the target named object path as specified during the creation of the `ACL` object",3,{"inputs":[{"name":"self"}],"output":{"name":"objecttype"}}],[11,"all","","Returns a `Vec<ACLEntry>` of access control list entries for the specified named object path.",3,{"inputs":[{"name":"self"}],"output":{"generics":["vec","dword"],"name":"result"}}],[11,"get","","Retrieves a list of access control entries matching the target SID entity and optionally, a access control entry type.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"generics":["acetype"],"name":"option"}],"output":{"generics":["vec","dword"],"name":"result"}}],[11,"reload","","Update the current named object path's security descriptor. Returns a boolean denoting the status of the reload operation.",3,{"inputs":[{"name":"self"}],"output":{"name":"bool"}}],[11,"add_entry","","Adds a custom entry into the access control list.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"name":"acetype"},{"name":"byte"},{"name":"dword"}],"output":{"generics":["bool","dword"],"name":"result"}}],[11,"remove_entry","","Removes access control list entries that match the specified parameters.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"generics":["acetype"],"name":"option"},{"generics":["byte"],"name":"option"}],"output":{"generics":["usize","dword"],"name":"result"}}],[11,"allow","","Adds an access allow entry to the access control list.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"name":"bool"},{"name":"dword"}],"output":{"generics":["bool","dword"],"name":"result"}}],[11,"deny","","Adds an access deny entry to the access control list.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"name":"bool"},{"name":"dword"}],"output":{"generics":["bool","dword"],"name":"result"}}],[11,"audit","","Adds a system audit entry to the access control list.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"name":"bool"},{"name":"dword"},{"name":"bool"},{"name":"bool"}],"output":{"generics":["bool","dword"],"name":"result"}}],[11,"integrity_level","","Adds a system mandatory level entry to the access control list. This sets the mandatory integrity level for the named object path.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"name":"bool"},{"name":"dword"}],"output":{"generics":["bool","dword"],"name":"result"}}],[11,"remove","","Removes access control list entries that match the specified parameters.",3,{"inputs":[{"name":"self"},{"name":"psid"},{"generics":["acetype"],"name":"option"},{"generics":["bool"],"name":"option"}],"output":{"generics":["usize","dword"],"name":"result"}}],[11,"drop","","",3,{"inputs":[{"name":"self"}],"output":null}],[0,"helper","windows_acl","",null,null],[5,"sid_to_string","windows_acl::helper","Converts a raw SID into a SID string representation.",null,{"inputs":[{"name":"psid"}],"output":{"generics":["string","dword"],"name":"result"}}],[5,"name_to_sid","","Resolves a system username (either in the format of \"user\" or \"DOMAIN\\user\") into a raw SID. The raw SID is represented by a `Vec<u8>` object.",null,{"inputs":[{"name":"str"},{"generics":["str"],"name":"option"}],"output":{"generics":["vec","dword"],"name":"result"}}],[5,"string_to_sid","","Converts a string representation of a SID into a raw SID. The returned raw SID is contained in a `Vec<u8>` object.",null,{"inputs":[{"name":"str"}],"output":{"generics":["vec","dword"],"name":"result"}}],[5,"current_user","","Retrieves the user name of the current user.",null,{"inputs":[],"output":{"generics":["string"],"name":"option"}}]],"paths":[[3,"ACLEntry"],[4,"ObjectType"],[4,"AceType"],[3,"ACL"]]};
initSearch(searchIndex);