1 // Copyright 2012 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
11 "golang.org/x/sys/internal/unsafeheader"
16 NameFullyQualifiedDN = 1
23 NameServicePrincipal = 10
27 // This function returns 1 byte BOOLEAN rather than the 4 byte BOOL.
28 // http://blogs.msdn.com/b/drnick/archive/2007/12/19/windows-and-upn-format-credentials.aspx
29 //sys TranslateName(accName *uint16, accNameFormat uint32, desiredNameFormat uint32, translatedName *uint16, nSize *uint32) (err error) [failretval&0xff==0] = secur32.TranslateNameW
30 //sys GetUserNameEx(nameFormat uint32, nameBuffre *uint16, nSize *uint32) (err error) [failretval&0xff==0] = secur32.GetUserNameExW
32 // TranslateAccountName converts a directory service
33 // object name from one format to another.
34 func TranslateAccountName(username string, from, to uint32, initSize int) (string, error) {
35 u, e := UTF16PtrFromString(username)
41 b := make([]uint16, n)
42 e = TranslateName(u, from, to, &b[0], &n)
44 return UTF16ToString(b[:n]), nil
46 if e != ERROR_INSUFFICIENT_BUFFER {
49 if n <= uint32(len(b)) {
57 NetSetupUnknownStatus = iota
63 type UserInfo10 struct {
70 //sys NetUserGetInfo(serverName *uint16, userName *uint16, level uint32, buf **byte) (neterr error) = netapi32.NetUserGetInfo
71 //sys NetGetJoinInformation(server *uint16, name **uint16, bufType *uint32) (neterr error) = netapi32.NetGetJoinInformation
72 //sys NetApiBufferFree(buf *byte) (neterr error) = netapi32.NetApiBufferFree
76 SidTypeUser = 1 + iota
88 type SidIdentifierAuthority struct {
93 SECURITY_NULL_SID_AUTHORITY = SidIdentifierAuthority{[6]byte{0, 0, 0, 0, 0, 0}}
94 SECURITY_WORLD_SID_AUTHORITY = SidIdentifierAuthority{[6]byte{0, 0, 0, 0, 0, 1}}
95 SECURITY_LOCAL_SID_AUTHORITY = SidIdentifierAuthority{[6]byte{0, 0, 0, 0, 0, 2}}
96 SECURITY_CREATOR_SID_AUTHORITY = SidIdentifierAuthority{[6]byte{0, 0, 0, 0, 0, 3}}
97 SECURITY_NON_UNIQUE_AUTHORITY = SidIdentifierAuthority{[6]byte{0, 0, 0, 0, 0, 4}}
98 SECURITY_NT_AUTHORITY = SidIdentifierAuthority{[6]byte{0, 0, 0, 0, 0, 5}}
99 SECURITY_MANDATORY_LABEL_AUTHORITY = SidIdentifierAuthority{[6]byte{0, 0, 0, 0, 0, 16}}
103 SECURITY_NULL_RID = 0
104 SECURITY_WORLD_RID = 0
105 SECURITY_LOCAL_RID = 0
106 SECURITY_CREATOR_OWNER_RID = 0
107 SECURITY_CREATOR_GROUP_RID = 1
108 SECURITY_DIALUP_RID = 1
109 SECURITY_NETWORK_RID = 2
110 SECURITY_BATCH_RID = 3
111 SECURITY_INTERACTIVE_RID = 4
112 SECURITY_LOGON_IDS_RID = 5
113 SECURITY_SERVICE_RID = 6
114 SECURITY_LOCAL_SYSTEM_RID = 18
115 SECURITY_BUILTIN_DOMAIN_RID = 32
116 SECURITY_PRINCIPAL_SELF_RID = 10
117 SECURITY_CREATOR_OWNER_SERVER_RID = 0x2
118 SECURITY_CREATOR_GROUP_SERVER_RID = 0x3
119 SECURITY_LOGON_IDS_RID_COUNT = 0x3
120 SECURITY_ANONYMOUS_LOGON_RID = 0x7
121 SECURITY_PROXY_RID = 0x8
122 SECURITY_ENTERPRISE_CONTROLLERS_RID = 0x9
123 SECURITY_SERVER_LOGON_RID = SECURITY_ENTERPRISE_CONTROLLERS_RID
124 SECURITY_AUTHENTICATED_USER_RID = 0xb
125 SECURITY_RESTRICTED_CODE_RID = 0xc
126 SECURITY_NT_NON_UNIQUE_RID = 0x15
129 // Predefined domain-relative RIDs for local groups.
130 // See https://msdn.microsoft.com/en-us/library/windows/desktop/aa379649(v=vs.85).aspx
132 DOMAIN_ALIAS_RID_ADMINS = 0x220
133 DOMAIN_ALIAS_RID_USERS = 0x221
134 DOMAIN_ALIAS_RID_GUESTS = 0x222
135 DOMAIN_ALIAS_RID_POWER_USERS = 0x223
136 DOMAIN_ALIAS_RID_ACCOUNT_OPS = 0x224
137 DOMAIN_ALIAS_RID_SYSTEM_OPS = 0x225
138 DOMAIN_ALIAS_RID_PRINT_OPS = 0x226
139 DOMAIN_ALIAS_RID_BACKUP_OPS = 0x227
140 DOMAIN_ALIAS_RID_REPLICATOR = 0x228
141 DOMAIN_ALIAS_RID_RAS_SERVERS = 0x229
142 DOMAIN_ALIAS_RID_PREW2KCOMPACCESS = 0x22a
143 DOMAIN_ALIAS_RID_REMOTE_DESKTOP_USERS = 0x22b
144 DOMAIN_ALIAS_RID_NETWORK_CONFIGURATION_OPS = 0x22c
145 DOMAIN_ALIAS_RID_INCOMING_FOREST_TRUST_BUILDERS = 0x22d
146 DOMAIN_ALIAS_RID_MONITORING_USERS = 0x22e
147 DOMAIN_ALIAS_RID_LOGGING_USERS = 0x22f
148 DOMAIN_ALIAS_RID_AUTHORIZATIONACCESS = 0x230
149 DOMAIN_ALIAS_RID_TS_LICENSE_SERVERS = 0x231
150 DOMAIN_ALIAS_RID_DCOM_USERS = 0x232
151 DOMAIN_ALIAS_RID_IUSERS = 0x238
152 DOMAIN_ALIAS_RID_CRYPTO_OPERATORS = 0x239
153 DOMAIN_ALIAS_RID_CACHEABLE_PRINCIPALS_GROUP = 0x23b
154 DOMAIN_ALIAS_RID_NON_CACHEABLE_PRINCIPALS_GROUP = 0x23c
155 DOMAIN_ALIAS_RID_EVENT_LOG_READERS_GROUP = 0x23d
156 DOMAIN_ALIAS_RID_CERTSVC_DCOM_ACCESS_GROUP = 0x23e
159 //sys LookupAccountSid(systemName *uint16, sid *SID, name *uint16, nameLen *uint32, refdDomainName *uint16, refdDomainNameLen *uint32, use *uint32) (err error) = advapi32.LookupAccountSidW
160 //sys LookupAccountName(systemName *uint16, accountName *uint16, sid *SID, sidLen *uint32, refdDomainName *uint16, refdDomainNameLen *uint32, use *uint32) (err error) = advapi32.LookupAccountNameW
161 //sys ConvertSidToStringSid(sid *SID, stringSid **uint16) (err error) = advapi32.ConvertSidToStringSidW
162 //sys ConvertStringSidToSid(stringSid *uint16, sid **SID) (err error) = advapi32.ConvertStringSidToSidW
163 //sys GetLengthSid(sid *SID) (len uint32) = advapi32.GetLengthSid
164 //sys CopySid(destSidLen uint32, destSid *SID, srcSid *SID) (err error) = advapi32.CopySid
165 //sys AllocateAndInitializeSid(identAuth *SidIdentifierAuthority, subAuth byte, subAuth0 uint32, subAuth1 uint32, subAuth2 uint32, subAuth3 uint32, subAuth4 uint32, subAuth5 uint32, subAuth6 uint32, subAuth7 uint32, sid **SID) (err error) = advapi32.AllocateAndInitializeSid
166 //sys createWellKnownSid(sidType WELL_KNOWN_SID_TYPE, domainSid *SID, sid *SID, sizeSid *uint32) (err error) = advapi32.CreateWellKnownSid
167 //sys isWellKnownSid(sid *SID, sidType WELL_KNOWN_SID_TYPE) (isWellKnown bool) = advapi32.IsWellKnownSid
168 //sys FreeSid(sid *SID) (err error) [failretval!=0] = advapi32.FreeSid
169 //sys EqualSid(sid1 *SID, sid2 *SID) (isEqual bool) = advapi32.EqualSid
170 //sys getSidIdentifierAuthority(sid *SID) (authority *SidIdentifierAuthority) = advapi32.GetSidIdentifierAuthority
171 //sys getSidSubAuthorityCount(sid *SID) (count *uint8) = advapi32.GetSidSubAuthorityCount
172 //sys getSidSubAuthority(sid *SID, index uint32) (subAuthority *uint32) = advapi32.GetSidSubAuthority
173 //sys isValidSid(sid *SID) (isValid bool) = advapi32.IsValidSid
175 // The security identifier (SID) structure is a variable-length
176 // structure used to uniquely identify users or groups.
179 // StringToSid converts a string-format security identifier
180 // SID into a valid, functional SID.
181 func StringToSid(s string) (*SID, error) {
183 p, e := UTF16PtrFromString(s)
187 e = ConvertStringSidToSid(p, &sid)
191 defer LocalFree((Handle)(unsafe.Pointer(sid)))
195 // LookupSID retrieves a security identifier SID for the account
196 // and the name of the domain on which the account was found.
197 // System specify target computer to search.
198 func LookupSID(system, account string) (sid *SID, domain string, accType uint32, err error) {
199 if len(account) == 0 {
200 return nil, "", 0, syscall.EINVAL
202 acc, e := UTF16PtrFromString(account)
208 sys, e = UTF16PtrFromString(system)
217 db := make([]uint16, dn)
218 sid = (*SID)(unsafe.Pointer(&b[0]))
219 e = LookupAccountName(sys, acc, sid, &n, &db[0], &dn, &accType)
221 return sid, UTF16ToString(db), accType, nil
223 if e != ERROR_INSUFFICIENT_BUFFER {
226 if n <= uint32(len(b)) {
232 // String converts SID to a string format suitable for display, storage, or transmission.
233 func (sid *SID) String() string {
235 e := ConvertSidToStringSid(sid, &s)
239 defer LocalFree((Handle)(unsafe.Pointer(s)))
240 return UTF16ToString((*[256]uint16)(unsafe.Pointer(s))[:])
243 // Len returns the length, in bytes, of a valid security identifier SID.
244 func (sid *SID) Len() int {
245 return int(GetLengthSid(sid))
248 // Copy creates a duplicate of security identifier SID.
249 func (sid *SID) Copy() (*SID, error) {
250 b := make([]byte, sid.Len())
251 sid2 := (*SID)(unsafe.Pointer(&b[0]))
252 e := CopySid(uint32(len(b)), sid2, sid)
259 // IdentifierAuthority returns the identifier authority of the SID.
260 func (sid *SID) IdentifierAuthority() SidIdentifierAuthority {
261 return *getSidIdentifierAuthority(sid)
264 // SubAuthorityCount returns the number of sub-authorities in the SID.
265 func (sid *SID) SubAuthorityCount() uint8 {
266 return *getSidSubAuthorityCount(sid)
269 // SubAuthority returns the sub-authority of the SID as specified by
270 // the index, which must be less than sid.SubAuthorityCount().
271 func (sid *SID) SubAuthority(idx uint32) uint32 {
272 if idx >= uint32(sid.SubAuthorityCount()) {
273 panic("sub-authority index out of range")
275 return *getSidSubAuthority(sid, idx)
278 // IsValid returns whether the SID has a valid revision and length.
279 func (sid *SID) IsValid() bool {
280 return isValidSid(sid)
283 // Equals compares two SIDs for equality.
284 func (sid *SID) Equals(sid2 *SID) bool {
285 return EqualSid(sid, sid2)
288 // IsWellKnown determines whether the SID matches the well-known sidType.
289 func (sid *SID) IsWellKnown(sidType WELL_KNOWN_SID_TYPE) bool {
290 return isWellKnownSid(sid, sidType)
293 // LookupAccount retrieves the name of the account for this SID
294 // and the name of the first domain on which this SID is found.
295 // System specify target computer to search for.
296 func (sid *SID) LookupAccount(system string) (account, domain string, accType uint32, err error) {
299 sys, err = UTF16PtrFromString(system)
301 return "", "", 0, err
307 b := make([]uint16, n)
308 db := make([]uint16, dn)
309 e := LookupAccountSid(sys, sid, &b[0], &n, &db[0], &dn, &accType)
311 return UTF16ToString(b), UTF16ToString(db), accType, nil
313 if e != ERROR_INSUFFICIENT_BUFFER {
316 if n <= uint32(len(b)) {
322 // Various types of pre-specified SIDs that can be synthesized and compared at runtime.
323 type WELL_KNOWN_SID_TYPE uint32
329 WinCreatorOwnerSid = 3
330 WinCreatorGroupSid = 4
331 WinCreatorOwnerServerSid = 5
332 WinCreatorGroupServerSid = 6
333 WinNtAuthoritySid = 7
337 WinInteractiveSid = 11
341 WinEnterpriseControllersSid = 15
343 WinAuthenticatedUserSid = 17
344 WinRestrictedCodeSid = 18
345 WinTerminalServerSid = 19
346 WinRemoteLogonIdSid = 20
348 WinLocalSystemSid = 22
349 WinLocalServiceSid = 23
350 WinNetworkServiceSid = 24
351 WinBuiltinDomainSid = 25
352 WinBuiltinAdministratorsSid = 26
353 WinBuiltinUsersSid = 27
354 WinBuiltinGuestsSid = 28
355 WinBuiltinPowerUsersSid = 29
356 WinBuiltinAccountOperatorsSid = 30
357 WinBuiltinSystemOperatorsSid = 31
358 WinBuiltinPrintOperatorsSid = 32
359 WinBuiltinBackupOperatorsSid = 33
360 WinBuiltinReplicatorSid = 34
361 WinBuiltinPreWindows2000CompatibleAccessSid = 35
362 WinBuiltinRemoteDesktopUsersSid = 36
363 WinBuiltinNetworkConfigurationOperatorsSid = 37
364 WinAccountAdministratorSid = 38
365 WinAccountGuestSid = 39
366 WinAccountKrbtgtSid = 40
367 WinAccountDomainAdminsSid = 41
368 WinAccountDomainUsersSid = 42
369 WinAccountDomainGuestsSid = 43
370 WinAccountComputersSid = 44
371 WinAccountControllersSid = 45
372 WinAccountCertAdminsSid = 46
373 WinAccountSchemaAdminsSid = 47
374 WinAccountEnterpriseAdminsSid = 48
375 WinAccountPolicyAdminsSid = 49
376 WinAccountRasAndIasServersSid = 50
377 WinNTLMAuthenticationSid = 51
378 WinDigestAuthenticationSid = 52
379 WinSChannelAuthenticationSid = 53
380 WinThisOrganizationSid = 54
381 WinOtherOrganizationSid = 55
382 WinBuiltinIncomingForestTrustBuildersSid = 56
383 WinBuiltinPerfMonitoringUsersSid = 57
384 WinBuiltinPerfLoggingUsersSid = 58
385 WinBuiltinAuthorizationAccessSid = 59
386 WinBuiltinTerminalServerLicenseServersSid = 60
387 WinBuiltinDCOMUsersSid = 61
388 WinBuiltinIUsersSid = 62
390 WinBuiltinCryptoOperatorsSid = 64
391 WinUntrustedLabelSid = 65
393 WinMediumLabelSid = 67
395 WinSystemLabelSid = 69
396 WinWriteRestrictedCodeSid = 70
397 WinCreatorOwnerRightsSid = 71
398 WinCacheablePrincipalsGroupSid = 72
399 WinNonCacheablePrincipalsGroupSid = 73
400 WinEnterpriseReadonlyControllersSid = 74
401 WinAccountReadonlyControllersSid = 75
402 WinBuiltinEventLogReadersGroup = 76
403 WinNewEnterpriseReadonlyControllersSid = 77
404 WinBuiltinCertSvcDComAccessGroup = 78
405 WinMediumPlusLabelSid = 79
406 WinLocalLogonSid = 80
407 WinConsoleLogonSid = 81
408 WinThisOrganizationCertificateSid = 82
409 WinApplicationPackageAuthoritySid = 83
410 WinBuiltinAnyPackageSid = 84
411 WinCapabilityInternetClientSid = 85
412 WinCapabilityInternetClientServerSid = 86
413 WinCapabilityPrivateNetworkClientServerSid = 87
414 WinCapabilityPicturesLibrarySid = 88
415 WinCapabilityVideosLibrarySid = 89
416 WinCapabilityMusicLibrarySid = 90
417 WinCapabilityDocumentsLibrarySid = 91
418 WinCapabilitySharedUserCertificatesSid = 92
419 WinCapabilityEnterpriseAuthenticationSid = 93
420 WinCapabilityRemovableStorageSid = 94
421 WinBuiltinRDSRemoteAccessServersSid = 95
422 WinBuiltinRDSEndpointServersSid = 96
423 WinBuiltinRDSManagementServersSid = 97
424 WinUserModeDriversSid = 98
425 WinBuiltinHyperVAdminsSid = 99
426 WinAccountCloneableControllersSid = 100
427 WinBuiltinAccessControlAssistanceOperatorsSid = 101
428 WinBuiltinRemoteManagementUsersSid = 102
429 WinAuthenticationAuthorityAssertedSid = 103
430 WinAuthenticationServiceAssertedSid = 104
431 WinLocalAccountSid = 105
432 WinLocalAccountAndAdministratorSid = 106
433 WinAccountProtectedUsersSid = 107
434 WinCapabilityAppointmentsSid = 108
435 WinCapabilityContactsSid = 109
436 WinAccountDefaultSystemManagedSid = 110
437 WinBuiltinDefaultSystemManagedGroupSid = 111
438 WinBuiltinStorageReplicaAdminsSid = 112
439 WinAccountKeyAdminsSid = 113
440 WinAccountEnterpriseKeyAdminsSid = 114
441 WinAuthenticationKeyTrustSid = 115
442 WinAuthenticationKeyPropertyMFASid = 116
443 WinAuthenticationKeyPropertyAttestationSid = 117
444 WinAuthenticationFreshKeyAuthSid = 118
445 WinBuiltinDeviceOwnersSid = 119
448 // Creates a SID for a well-known predefined alias, generally using the constants of the form
449 // Win*Sid, for the local machine.
450 func CreateWellKnownSid(sidType WELL_KNOWN_SID_TYPE) (*SID, error) {
451 return CreateWellKnownDomainSid(sidType, nil)
454 // Creates a SID for a well-known predefined alias, generally using the constants of the form
455 // Win*Sid, for the domain specified by the domainSid parameter.
456 func CreateWellKnownDomainSid(sidType WELL_KNOWN_SID_TYPE, domainSid *SID) (*SID, error) {
460 sid := (*SID)(unsafe.Pointer(&b[0]))
461 err := createWellKnownSid(sidType, domainSid, sid, &n)
465 if err != ERROR_INSUFFICIENT_BUFFER {
468 if n <= uint32(len(b)) {
476 TOKEN_ASSIGN_PRIMARY = 1 << iota
481 TOKEN_ADJUST_PRIVILEGES
484 TOKEN_ADJUST_SESSIONID
486 TOKEN_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED |
487 TOKEN_ASSIGN_PRIMARY |
492 TOKEN_ADJUST_PRIVILEGES |
493 TOKEN_ADJUST_GROUPS |
494 TOKEN_ADJUST_DEFAULT |
495 TOKEN_ADJUST_SESSIONID
496 TOKEN_READ = STANDARD_RIGHTS_READ | TOKEN_QUERY
497 TOKEN_WRITE = STANDARD_RIGHTS_WRITE |
498 TOKEN_ADJUST_PRIVILEGES |
499 TOKEN_ADJUST_GROUPS |
501 TOKEN_EXECUTE = STANDARD_RIGHTS_EXECUTE
514 TokenImpersonationLevel
518 TokenGroupsAndPrivileges
519 TokenSessionReference
527 TokenAccessInformation
528 TokenVirtualizationAllowed
529 TokenVirtualizationEnabled
537 // Group attributes inside of Tokengroups.Groups[i].Attributes
539 SE_GROUP_MANDATORY = 0x00000001
540 SE_GROUP_ENABLED_BY_DEFAULT = 0x00000002
541 SE_GROUP_ENABLED = 0x00000004
542 SE_GROUP_OWNER = 0x00000008
543 SE_GROUP_USE_FOR_DENY_ONLY = 0x00000010
544 SE_GROUP_INTEGRITY = 0x00000020
545 SE_GROUP_INTEGRITY_ENABLED = 0x00000040
546 SE_GROUP_LOGON_ID = 0xC0000000
547 SE_GROUP_RESOURCE = 0x20000000
548 SE_GROUP_VALID_ATTRIBUTES = SE_GROUP_MANDATORY | SE_GROUP_ENABLED_BY_DEFAULT | SE_GROUP_ENABLED | SE_GROUP_OWNER | SE_GROUP_USE_FOR_DENY_ONLY | SE_GROUP_LOGON_ID | SE_GROUP_RESOURCE | SE_GROUP_INTEGRITY | SE_GROUP_INTEGRITY_ENABLED
551 // Privilege attributes
553 SE_PRIVILEGE_ENABLED_BY_DEFAULT = 0x00000001
554 SE_PRIVILEGE_ENABLED = 0x00000002
555 SE_PRIVILEGE_REMOVED = 0x00000004
556 SE_PRIVILEGE_USED_FOR_ACCESS = 0x80000000
557 SE_PRIVILEGE_VALID_ATTRIBUTES = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED | SE_PRIVILEGE_REMOVED | SE_PRIVILEGE_USED_FOR_ACCESS
563 TokenImpersonation = 2
566 // Impersonation levels
568 SecurityAnonymous = 0
569 SecurityIdentification = 1
570 SecurityImpersonation = 2
571 SecurityDelegation = 3
579 type LUIDAndAttributes struct {
584 type SIDAndAttributes struct {
589 type Tokenuser struct {
590 User SIDAndAttributes
593 type Tokenprimarygroup struct {
597 type Tokengroups struct {
599 Groups [1]SIDAndAttributes // Use AllGroups() for iterating.
602 // AllGroups returns a slice that can be used to iterate over the groups in g.
603 func (g *Tokengroups) AllGroups() []SIDAndAttributes {
604 return (*[(1 << 28) - 1]SIDAndAttributes)(unsafe.Pointer(&g.Groups[0]))[:g.GroupCount:g.GroupCount]
607 type Tokenprivileges struct {
608 PrivilegeCount uint32
609 Privileges [1]LUIDAndAttributes // Use AllPrivileges() for iterating.
612 // AllPrivileges returns a slice that can be used to iterate over the privileges in p.
613 func (p *Tokenprivileges) AllPrivileges() []LUIDAndAttributes {
614 return (*[(1 << 27) - 1]LUIDAndAttributes)(unsafe.Pointer(&p.Privileges[0]))[:p.PrivilegeCount:p.PrivilegeCount]
617 type Tokenmandatorylabel struct {
618 Label SIDAndAttributes
621 func (tml *Tokenmandatorylabel) Size() uint32 {
622 return uint32(unsafe.Sizeof(Tokenmandatorylabel{})) + GetLengthSid(tml.Label.Sid)
625 // Authorization Functions
626 //sys checkTokenMembership(tokenHandle Token, sidToCheck *SID, isMember *int32) (err error) = advapi32.CheckTokenMembership
627 //sys isTokenRestricted(tokenHandle Token) (ret bool, err error) [!failretval] = advapi32.IsTokenRestricted
628 //sys OpenProcessToken(process Handle, access uint32, token *Token) (err error) = advapi32.OpenProcessToken
629 //sys OpenThreadToken(thread Handle, access uint32, openAsSelf bool, token *Token) (err error) = advapi32.OpenThreadToken
630 //sys ImpersonateSelf(impersonationlevel uint32) (err error) = advapi32.ImpersonateSelf
631 //sys RevertToSelf() (err error) = advapi32.RevertToSelf
632 //sys SetThreadToken(thread *Handle, token Token) (err error) = advapi32.SetThreadToken
633 //sys LookupPrivilegeValue(systemname *uint16, name *uint16, luid *LUID) (err error) = advapi32.LookupPrivilegeValueW
634 //sys AdjustTokenPrivileges(token Token, disableAllPrivileges bool, newstate *Tokenprivileges, buflen uint32, prevstate *Tokenprivileges, returnlen *uint32) (err error) = advapi32.AdjustTokenPrivileges
635 //sys AdjustTokenGroups(token Token, resetToDefault bool, newstate *Tokengroups, buflen uint32, prevstate *Tokengroups, returnlen *uint32) (err error) = advapi32.AdjustTokenGroups
636 //sys GetTokenInformation(token Token, infoClass uint32, info *byte, infoLen uint32, returnedLen *uint32) (err error) = advapi32.GetTokenInformation
637 //sys SetTokenInformation(token Token, infoClass uint32, info *byte, infoLen uint32) (err error) = advapi32.SetTokenInformation
638 //sys DuplicateTokenEx(existingToken Token, desiredAccess uint32, tokenAttributes *SecurityAttributes, impersonationLevel uint32, tokenType uint32, newToken *Token) (err error) = advapi32.DuplicateTokenEx
639 //sys GetUserProfileDirectory(t Token, dir *uint16, dirLen *uint32) (err error) = userenv.GetUserProfileDirectoryW
640 //sys getSystemDirectory(dir *uint16, dirLen uint32) (len uint32, err error) = kernel32.GetSystemDirectoryW
641 //sys getWindowsDirectory(dir *uint16, dirLen uint32) (len uint32, err error) = kernel32.GetWindowsDirectoryW
642 //sys getSystemWindowsDirectory(dir *uint16, dirLen uint32) (len uint32, err error) = kernel32.GetSystemWindowsDirectoryW
644 // An access token contains the security information for a logon session.
645 // The system creates an access token when a user logs on, and every
646 // process executed on behalf of the user has a copy of the token.
647 // The token identifies the user, the user's groups, and the user's
648 // privileges. The system uses the token to control access to securable
649 // objects and to control the ability of the user to perform various
650 // system-related operations on the local computer.
653 // OpenCurrentProcessToken opens an access token associated with current
654 // process with TOKEN_QUERY access. It is a real token that needs to be closed.
656 // Deprecated: Explicitly call OpenProcessToken(CurrentProcess(), ...)
657 // with the desired access instead, or use GetCurrentProcessToken for a
658 // TOKEN_QUERY token.
659 func OpenCurrentProcessToken() (Token, error) {
661 err := OpenProcessToken(CurrentProcess(), TOKEN_QUERY, &token)
665 // GetCurrentProcessToken returns the access token associated with
666 // the current process. It is a pseudo token that does not need
668 func GetCurrentProcessToken() Token {
669 return Token(^uintptr(4 - 1))
672 // GetCurrentThreadToken return the access token associated with
673 // the current thread. It is a pseudo token that does not need
675 func GetCurrentThreadToken() Token {
676 return Token(^uintptr(5 - 1))
679 // GetCurrentThreadEffectiveToken returns the effective access token
680 // associated with the current thread. It is a pseudo token that does
681 // not need to be closed.
682 func GetCurrentThreadEffectiveToken() Token {
683 return Token(^uintptr(6 - 1))
686 // Close releases access to access token.
687 func (t Token) Close() error {
688 return CloseHandle(Handle(t))
691 // getInfo retrieves a specified type of information about an access token.
692 func (t Token) getInfo(class uint32, initSize int) (unsafe.Pointer, error) {
693 n := uint32(initSize)
696 e := GetTokenInformation(t, class, &b[0], uint32(len(b)), &n)
698 return unsafe.Pointer(&b[0]), nil
700 if e != ERROR_INSUFFICIENT_BUFFER {
703 if n <= uint32(len(b)) {
709 // GetTokenUser retrieves access token t user account information.
710 func (t Token) GetTokenUser() (*Tokenuser, error) {
711 i, e := t.getInfo(TokenUser, 50)
715 return (*Tokenuser)(i), nil
718 // GetTokenGroups retrieves group accounts associated with access token t.
719 func (t Token) GetTokenGroups() (*Tokengroups, error) {
720 i, e := t.getInfo(TokenGroups, 50)
724 return (*Tokengroups)(i), nil
727 // GetTokenPrimaryGroup retrieves access token t primary group information.
728 // A pointer to a SID structure representing a group that will become
729 // the primary group of any objects created by a process using this access token.
730 func (t Token) GetTokenPrimaryGroup() (*Tokenprimarygroup, error) {
731 i, e := t.getInfo(TokenPrimaryGroup, 50)
735 return (*Tokenprimarygroup)(i), nil
738 // GetUserProfileDirectory retrieves path to the
739 // root directory of the access token t user's profile.
740 func (t Token) GetUserProfileDirectory() (string, error) {
743 b := make([]uint16, n)
744 e := GetUserProfileDirectory(t, &b[0], &n)
746 return UTF16ToString(b), nil
748 if e != ERROR_INSUFFICIENT_BUFFER {
751 if n <= uint32(len(b)) {
757 // IsElevated returns whether the current token is elevated from a UAC perspective.
758 func (token Token) IsElevated() bool {
759 var isElevated uint32
761 err := GetTokenInformation(token, TokenElevation, (*byte)(unsafe.Pointer(&isElevated)), uint32(unsafe.Sizeof(isElevated)), &outLen)
765 return outLen == uint32(unsafe.Sizeof(isElevated)) && isElevated != 0
768 // GetLinkedToken returns the linked token, which may be an elevated UAC token.
769 func (token Token) GetLinkedToken() (Token, error) {
770 var linkedToken Token
772 err := GetTokenInformation(token, TokenLinkedToken, (*byte)(unsafe.Pointer(&linkedToken)), uint32(unsafe.Sizeof(linkedToken)), &outLen)
776 return linkedToken, nil
779 // GetSystemDirectory retrieves the path to current location of the system
780 // directory, which is typically, though not always, `C:\Windows\System32`.
781 func GetSystemDirectory() (string, error) {
782 n := uint32(MAX_PATH)
784 b := make([]uint16, n)
785 l, e := getSystemDirectory(&b[0], n)
790 return UTF16ToString(b[:l]), nil
796 // GetWindowsDirectory retrieves the path to current location of the Windows
797 // directory, which is typically, though not always, `C:\Windows`. This may
798 // be a private user directory in the case that the application is running
799 // under a terminal server.
800 func GetWindowsDirectory() (string, error) {
801 n := uint32(MAX_PATH)
803 b := make([]uint16, n)
804 l, e := getWindowsDirectory(&b[0], n)
809 return UTF16ToString(b[:l]), nil
815 // GetSystemWindowsDirectory retrieves the path to current location of the
816 // Windows directory, which is typically, though not always, `C:\Windows`.
817 func GetSystemWindowsDirectory() (string, error) {
818 n := uint32(MAX_PATH)
820 b := make([]uint16, n)
821 l, e := getSystemWindowsDirectory(&b[0], n)
826 return UTF16ToString(b[:l]), nil
832 // IsMember reports whether the access token t is a member of the provided SID.
833 func (t Token) IsMember(sid *SID) (bool, error) {
835 if e := checkTokenMembership(t, sid, &b); e != nil {
841 // IsRestricted reports whether the access token t is a restricted token.
842 func (t Token) IsRestricted() (isRestricted bool, err error) {
843 isRestricted, err = isTokenRestricted(t)
844 if !isRestricted && err == syscall.EINVAL {
845 // If err is EINVAL, this returned ERROR_SUCCESS indicating a non-restricted token.
852 WTS_CONSOLE_CONNECT = 0x1
853 WTS_CONSOLE_DISCONNECT = 0x2
854 WTS_REMOTE_CONNECT = 0x3
855 WTS_REMOTE_DISCONNECT = 0x4
856 WTS_SESSION_LOGON = 0x5
857 WTS_SESSION_LOGOFF = 0x6
858 WTS_SESSION_LOCK = 0x7
859 WTS_SESSION_UNLOCK = 0x8
860 WTS_SESSION_REMOTE_CONTROL = 0x9
861 WTS_SESSION_CREATE = 0xa
862 WTS_SESSION_TERMINATE = 0xb
878 type WTSSESSION_NOTIFICATION struct {
883 type WTS_SESSION_INFO struct {
885 WindowStationName *uint16
889 //sys WTSQueryUserToken(session uint32, token *Token) (err error) = wtsapi32.WTSQueryUserToken
890 //sys WTSEnumerateSessions(handle Handle, reserved uint32, version uint32, sessions **WTS_SESSION_INFO, count *uint32) (err error) = wtsapi32.WTSEnumerateSessionsW
891 //sys WTSFreeMemory(ptr uintptr) = wtsapi32.WTSFreeMemory
901 type SECURITY_DESCRIPTOR struct {
904 control SECURITY_DESCRIPTOR_CONTROL
911 type SecurityAttributes struct {
913 SecurityDescriptor *SECURITY_DESCRIPTOR
917 type SE_OBJECT_TYPE uint32
919 // Constants for type SE_OBJECT_TYPE
921 SE_UNKNOWN_OBJECT_TYPE = 0
931 SE_PROVIDER_DEFINED_OBJECT = 10
932 SE_WMIGUID_OBJECT = 11
933 SE_REGISTRY_WOW64_32KEY = 12
934 SE_REGISTRY_WOW64_64KEY = 13
937 type SECURITY_INFORMATION uint32
939 // Constants for type SECURITY_INFORMATION
941 OWNER_SECURITY_INFORMATION = 0x00000001
942 GROUP_SECURITY_INFORMATION = 0x00000002
943 DACL_SECURITY_INFORMATION = 0x00000004
944 SACL_SECURITY_INFORMATION = 0x00000008
945 LABEL_SECURITY_INFORMATION = 0x00000010
946 ATTRIBUTE_SECURITY_INFORMATION = 0x00000020
947 SCOPE_SECURITY_INFORMATION = 0x00000040
948 BACKUP_SECURITY_INFORMATION = 0x00010000
949 PROTECTED_DACL_SECURITY_INFORMATION = 0x80000000
950 PROTECTED_SACL_SECURITY_INFORMATION = 0x40000000
951 UNPROTECTED_DACL_SECURITY_INFORMATION = 0x20000000
952 UNPROTECTED_SACL_SECURITY_INFORMATION = 0x10000000
955 type SECURITY_DESCRIPTOR_CONTROL uint16
957 // Constants for type SECURITY_DESCRIPTOR_CONTROL
959 SE_OWNER_DEFAULTED = 0x0001
960 SE_GROUP_DEFAULTED = 0x0002
961 SE_DACL_PRESENT = 0x0004
962 SE_DACL_DEFAULTED = 0x0008
963 SE_SACL_PRESENT = 0x0010
964 SE_SACL_DEFAULTED = 0x0020
965 SE_DACL_AUTO_INHERIT_REQ = 0x0100
966 SE_SACL_AUTO_INHERIT_REQ = 0x0200
967 SE_DACL_AUTO_INHERITED = 0x0400
968 SE_SACL_AUTO_INHERITED = 0x0800
969 SE_DACL_PROTECTED = 0x1000
970 SE_SACL_PROTECTED = 0x2000
971 SE_RM_CONTROL_VALID = 0x4000
972 SE_SELF_RELATIVE = 0x8000
975 type ACCESS_MASK uint32
977 // Constants for type ACCESS_MASK
980 READ_CONTROL = 0x00020000
981 WRITE_DAC = 0x00040000
982 WRITE_OWNER = 0x00080000
983 SYNCHRONIZE = 0x00100000
984 STANDARD_RIGHTS_REQUIRED = 0x000F0000
985 STANDARD_RIGHTS_READ = READ_CONTROL
986 STANDARD_RIGHTS_WRITE = READ_CONTROL
987 STANDARD_RIGHTS_EXECUTE = READ_CONTROL
988 STANDARD_RIGHTS_ALL = 0x001F0000
989 SPECIFIC_RIGHTS_ALL = 0x0000FFFF
990 ACCESS_SYSTEM_SECURITY = 0x01000000
991 MAXIMUM_ALLOWED = 0x02000000
992 GENERIC_READ = 0x80000000
993 GENERIC_WRITE = 0x40000000
994 GENERIC_EXECUTE = 0x20000000
995 GENERIC_ALL = 0x10000000
998 type ACCESS_MODE uint32
1000 // Constants for type ACCESS_MODE
1007 SET_AUDIT_SUCCESS = 5
1008 SET_AUDIT_FAILURE = 6
1011 // Constants for AceFlags and Inheritance fields
1013 NO_INHERITANCE = 0x0
1014 SUB_OBJECTS_ONLY_INHERIT = 0x1
1015 SUB_CONTAINERS_ONLY_INHERIT = 0x2
1016 SUB_CONTAINERS_AND_OBJECTS_INHERIT = 0x3
1017 INHERIT_NO_PROPAGATE = 0x4
1019 INHERITED_ACCESS_ENTRY = 0x10
1020 INHERITED_PARENT = 0x10000000
1021 INHERITED_GRANDPARENT = 0x20000000
1022 OBJECT_INHERIT_ACE = 0x1
1023 CONTAINER_INHERIT_ACE = 0x2
1024 NO_PROPAGATE_INHERIT_ACE = 0x4
1025 INHERIT_ONLY_ACE = 0x8
1026 INHERITED_ACE = 0x10
1027 VALID_INHERIT_FLAGS = 0x1F
1030 type MULTIPLE_TRUSTEE_OPERATION uint32
1032 // Constants for MULTIPLE_TRUSTEE_OPERATION
1034 NO_MULTIPLE_TRUSTEE = 0
1035 TRUSTEE_IS_IMPERSONATE = 1
1038 type TRUSTEE_FORM uint32
1040 // Constants for TRUSTEE_FORM
1044 TRUSTEE_BAD_FORM = 2
1045 TRUSTEE_IS_OBJECTS_AND_SID = 3
1046 TRUSTEE_IS_OBJECTS_AND_NAME = 4
1049 type TRUSTEE_TYPE uint32
1051 // Constants for TRUSTEE_TYPE
1053 TRUSTEE_IS_UNKNOWN = 0
1055 TRUSTEE_IS_GROUP = 2
1056 TRUSTEE_IS_DOMAIN = 3
1057 TRUSTEE_IS_ALIAS = 4
1058 TRUSTEE_IS_WELL_KNOWN_GROUP = 5
1059 TRUSTEE_IS_DELETED = 6
1060 TRUSTEE_IS_INVALID = 7
1061 TRUSTEE_IS_COMPUTER = 8
1064 // Constants for ObjectsPresent field
1066 ACE_OBJECT_TYPE_PRESENT = 0x1
1067 ACE_INHERITED_OBJECT_TYPE_PRESENT = 0x2
1070 type EXPLICIT_ACCESS struct {
1071 AccessPermissions ACCESS_MASK
1072 AccessMode ACCESS_MODE
1077 // This type is the union inside of TRUSTEE and must be created using one of the TrusteeValueFrom* functions.
1078 type TrusteeValue uintptr
1080 func TrusteeValueFromString(str string) TrusteeValue {
1081 return TrusteeValue(unsafe.Pointer(StringToUTF16Ptr(str)))
1083 func TrusteeValueFromSID(sid *SID) TrusteeValue {
1084 return TrusteeValue(unsafe.Pointer(sid))
1086 func TrusteeValueFromObjectsAndSid(objectsAndSid *OBJECTS_AND_SID) TrusteeValue {
1087 return TrusteeValue(unsafe.Pointer(objectsAndSid))
1089 func TrusteeValueFromObjectsAndName(objectsAndName *OBJECTS_AND_NAME) TrusteeValue {
1090 return TrusteeValue(unsafe.Pointer(objectsAndName))
1093 type TRUSTEE struct {
1094 MultipleTrustee *TRUSTEE
1095 MultipleTrusteeOperation MULTIPLE_TRUSTEE_OPERATION
1096 TrusteeForm TRUSTEE_FORM
1097 TrusteeType TRUSTEE_TYPE
1098 TrusteeValue TrusteeValue
1101 type OBJECTS_AND_SID struct {
1102 ObjectsPresent uint32
1104 InheritedObjectTypeGuid GUID
1108 type OBJECTS_AND_NAME struct {
1109 ObjectsPresent uint32
1110 ObjectType SE_OBJECT_TYPE
1111 ObjectTypeName *uint16
1112 InheritedObjectTypeName *uint16
1116 //sys getSecurityInfo(handle Handle, objectType SE_OBJECT_TYPE, securityInformation SECURITY_INFORMATION, owner **SID, group **SID, dacl **ACL, sacl **ACL, sd **SECURITY_DESCRIPTOR) (ret error) = advapi32.GetSecurityInfo
1117 //sys SetSecurityInfo(handle Handle, objectType SE_OBJECT_TYPE, securityInformation SECURITY_INFORMATION, owner *SID, group *SID, dacl *ACL, sacl *ACL) (ret error) = advapi32.SetSecurityInfo
1118 //sys getNamedSecurityInfo(objectName string, objectType SE_OBJECT_TYPE, securityInformation SECURITY_INFORMATION, owner **SID, group **SID, dacl **ACL, sacl **ACL, sd **SECURITY_DESCRIPTOR) (ret error) = advapi32.GetNamedSecurityInfoW
1119 //sys SetNamedSecurityInfo(objectName string, objectType SE_OBJECT_TYPE, securityInformation SECURITY_INFORMATION, owner *SID, group *SID, dacl *ACL, sacl *ACL) (ret error) = advapi32.SetNamedSecurityInfoW
1120 //sys SetKernelObjectSecurity(handle Handle, securityInformation SECURITY_INFORMATION, securityDescriptor *SECURITY_DESCRIPTOR) (err error) = advapi32.SetKernelObjectSecurity
1122 //sys buildSecurityDescriptor(owner *TRUSTEE, group *TRUSTEE, countAccessEntries uint32, accessEntries *EXPLICIT_ACCESS, countAuditEntries uint32, auditEntries *EXPLICIT_ACCESS, oldSecurityDescriptor *SECURITY_DESCRIPTOR, sizeNewSecurityDescriptor *uint32, newSecurityDescriptor **SECURITY_DESCRIPTOR) (ret error) = advapi32.BuildSecurityDescriptorW
1123 //sys initializeSecurityDescriptor(absoluteSD *SECURITY_DESCRIPTOR, revision uint32) (err error) = advapi32.InitializeSecurityDescriptor
1125 //sys getSecurityDescriptorControl(sd *SECURITY_DESCRIPTOR, control *SECURITY_DESCRIPTOR_CONTROL, revision *uint32) (err error) = advapi32.GetSecurityDescriptorControl
1126 //sys getSecurityDescriptorDacl(sd *SECURITY_DESCRIPTOR, daclPresent *bool, dacl **ACL, daclDefaulted *bool) (err error) = advapi32.GetSecurityDescriptorDacl
1127 //sys getSecurityDescriptorSacl(sd *SECURITY_DESCRIPTOR, saclPresent *bool, sacl **ACL, saclDefaulted *bool) (err error) = advapi32.GetSecurityDescriptorSacl
1128 //sys getSecurityDescriptorOwner(sd *SECURITY_DESCRIPTOR, owner **SID, ownerDefaulted *bool) (err error) = advapi32.GetSecurityDescriptorOwner
1129 //sys getSecurityDescriptorGroup(sd *SECURITY_DESCRIPTOR, group **SID, groupDefaulted *bool) (err error) = advapi32.GetSecurityDescriptorGroup
1130 //sys getSecurityDescriptorLength(sd *SECURITY_DESCRIPTOR) (len uint32) = advapi32.GetSecurityDescriptorLength
1131 //sys getSecurityDescriptorRMControl(sd *SECURITY_DESCRIPTOR, rmControl *uint8) (ret error) [failretval!=0] = advapi32.GetSecurityDescriptorRMControl
1132 //sys isValidSecurityDescriptor(sd *SECURITY_DESCRIPTOR) (isValid bool) = advapi32.IsValidSecurityDescriptor
1134 //sys setSecurityDescriptorControl(sd *SECURITY_DESCRIPTOR, controlBitsOfInterest SECURITY_DESCRIPTOR_CONTROL, controlBitsToSet SECURITY_DESCRIPTOR_CONTROL) (err error) = advapi32.SetSecurityDescriptorControl
1135 //sys setSecurityDescriptorDacl(sd *SECURITY_DESCRIPTOR, daclPresent bool, dacl *ACL, daclDefaulted bool) (err error) = advapi32.SetSecurityDescriptorDacl
1136 //sys setSecurityDescriptorSacl(sd *SECURITY_DESCRIPTOR, saclPresent bool, sacl *ACL, saclDefaulted bool) (err error) = advapi32.SetSecurityDescriptorSacl
1137 //sys setSecurityDescriptorOwner(sd *SECURITY_DESCRIPTOR, owner *SID, ownerDefaulted bool) (err error) = advapi32.SetSecurityDescriptorOwner
1138 //sys setSecurityDescriptorGroup(sd *SECURITY_DESCRIPTOR, group *SID, groupDefaulted bool) (err error) = advapi32.SetSecurityDescriptorGroup
1139 //sys setSecurityDescriptorRMControl(sd *SECURITY_DESCRIPTOR, rmControl *uint8) = advapi32.SetSecurityDescriptorRMControl
1141 //sys convertStringSecurityDescriptorToSecurityDescriptor(str string, revision uint32, sd **SECURITY_DESCRIPTOR, size *uint32) (err error) = advapi32.ConvertStringSecurityDescriptorToSecurityDescriptorW
1142 //sys convertSecurityDescriptorToStringSecurityDescriptor(sd *SECURITY_DESCRIPTOR, revision uint32, securityInformation SECURITY_INFORMATION, str **uint16, strLen *uint32) (err error) = advapi32.ConvertSecurityDescriptorToStringSecurityDescriptorW
1144 //sys makeAbsoluteSD(selfRelativeSD *SECURITY_DESCRIPTOR, absoluteSD *SECURITY_DESCRIPTOR, absoluteSDSize *uint32, dacl *ACL, daclSize *uint32, sacl *ACL, saclSize *uint32, owner *SID, ownerSize *uint32, group *SID, groupSize *uint32) (err error) = advapi32.MakeAbsoluteSD
1145 //sys makeSelfRelativeSD(absoluteSD *SECURITY_DESCRIPTOR, selfRelativeSD *SECURITY_DESCRIPTOR, selfRelativeSDSize *uint32) (err error) = advapi32.MakeSelfRelativeSD
1147 //sys setEntriesInAcl(countExplicitEntries uint32, explicitEntries *EXPLICIT_ACCESS, oldACL *ACL, newACL **ACL) (ret error) = advapi32.SetEntriesInAclW
1149 // Control returns the security descriptor control bits.
1150 func (sd *SECURITY_DESCRIPTOR) Control() (control SECURITY_DESCRIPTOR_CONTROL, revision uint32, err error) {
1151 err = getSecurityDescriptorControl(sd, &control, &revision)
1155 // SetControl sets the security descriptor control bits.
1156 func (sd *SECURITY_DESCRIPTOR) SetControl(controlBitsOfInterest SECURITY_DESCRIPTOR_CONTROL, controlBitsToSet SECURITY_DESCRIPTOR_CONTROL) error {
1157 return setSecurityDescriptorControl(sd, controlBitsOfInterest, controlBitsToSet)
1160 // RMControl returns the security descriptor resource manager control bits.
1161 func (sd *SECURITY_DESCRIPTOR) RMControl() (control uint8, err error) {
1162 err = getSecurityDescriptorRMControl(sd, &control)
1166 // SetRMControl sets the security descriptor resource manager control bits.
1167 func (sd *SECURITY_DESCRIPTOR) SetRMControl(rmControl uint8) {
1168 setSecurityDescriptorRMControl(sd, &rmControl)
1171 // DACL returns the security descriptor DACL and whether it was defaulted. The dacl return value may be nil
1172 // if a DACL exists but is an "empty DACL", meaning fully permissive. If the DACL does not exist, err returns
1173 // ERROR_OBJECT_NOT_FOUND.
1174 func (sd *SECURITY_DESCRIPTOR) DACL() (dacl *ACL, defaulted bool, err error) {
1176 err = getSecurityDescriptorDacl(sd, &present, &dacl, &defaulted)
1178 err = ERROR_OBJECT_NOT_FOUND
1183 // SetDACL sets the absolute security descriptor DACL.
1184 func (absoluteSD *SECURITY_DESCRIPTOR) SetDACL(dacl *ACL, present, defaulted bool) error {
1185 return setSecurityDescriptorDacl(absoluteSD, present, dacl, defaulted)
1188 // SACL returns the security descriptor SACL and whether it was defaulted. The sacl return value may be nil
1189 // if a SACL exists but is an "empty SACL", meaning fully permissive. If the SACL does not exist, err returns
1190 // ERROR_OBJECT_NOT_FOUND.
1191 func (sd *SECURITY_DESCRIPTOR) SACL() (sacl *ACL, defaulted bool, err error) {
1193 err = getSecurityDescriptorSacl(sd, &present, &sacl, &defaulted)
1195 err = ERROR_OBJECT_NOT_FOUND
1200 // SetSACL sets the absolute security descriptor SACL.
1201 func (absoluteSD *SECURITY_DESCRIPTOR) SetSACL(sacl *ACL, present, defaulted bool) error {
1202 return setSecurityDescriptorSacl(absoluteSD, present, sacl, defaulted)
1205 // Owner returns the security descriptor owner and whether it was defaulted.
1206 func (sd *SECURITY_DESCRIPTOR) Owner() (owner *SID, defaulted bool, err error) {
1207 err = getSecurityDescriptorOwner(sd, &owner, &defaulted)
1211 // SetOwner sets the absolute security descriptor owner.
1212 func (absoluteSD *SECURITY_DESCRIPTOR) SetOwner(owner *SID, defaulted bool) error {
1213 return setSecurityDescriptorOwner(absoluteSD, owner, defaulted)
1216 // Group returns the security descriptor group and whether it was defaulted.
1217 func (sd *SECURITY_DESCRIPTOR) Group() (group *SID, defaulted bool, err error) {
1218 err = getSecurityDescriptorGroup(sd, &group, &defaulted)
1222 // SetGroup sets the absolute security descriptor owner.
1223 func (absoluteSD *SECURITY_DESCRIPTOR) SetGroup(group *SID, defaulted bool) error {
1224 return setSecurityDescriptorGroup(absoluteSD, group, defaulted)
1227 // Length returns the length of the security descriptor.
1228 func (sd *SECURITY_DESCRIPTOR) Length() uint32 {
1229 return getSecurityDescriptorLength(sd)
1232 // IsValid returns whether the security descriptor is valid.
1233 func (sd *SECURITY_DESCRIPTOR) IsValid() bool {
1234 return isValidSecurityDescriptor(sd)
1237 // String returns the SDDL form of the security descriptor, with a function signature that can be
1238 // used with %v formatting directives.
1239 func (sd *SECURITY_DESCRIPTOR) String() string {
1241 err := convertSecurityDescriptorToStringSecurityDescriptor(sd, 1, 0xff, &sddl, nil)
1245 defer LocalFree(Handle(unsafe.Pointer(sddl)))
1246 return UTF16PtrToString(sddl)
1249 // ToAbsolute converts a self-relative security descriptor into an absolute one.
1250 func (selfRelativeSD *SECURITY_DESCRIPTOR) ToAbsolute() (absoluteSD *SECURITY_DESCRIPTOR, err error) {
1251 control, _, err := selfRelativeSD.Control()
1255 if control&SE_SELF_RELATIVE == 0 {
1256 err = ERROR_INVALID_PARAMETER
1259 var absoluteSDSize, daclSize, saclSize, ownerSize, groupSize uint32
1260 err = makeAbsoluteSD(selfRelativeSD, nil, &absoluteSDSize,
1261 nil, &daclSize, nil, &saclSize, nil, &ownerSize, nil, &groupSize)
1263 case ERROR_INSUFFICIENT_BUFFER:
1265 // makeAbsoluteSD is expected to fail, but it succeeds.
1266 return nil, ERROR_INTERNAL_ERROR
1270 if absoluteSDSize > 0 {
1271 absoluteSD = (*SECURITY_DESCRIPTOR)(unsafe.Pointer(&make([]byte, absoluteSDSize)[0]))
1280 dacl = (*ACL)(unsafe.Pointer(&make([]byte, daclSize)[0]))
1283 sacl = (*ACL)(unsafe.Pointer(&make([]byte, saclSize)[0]))
1286 owner = (*SID)(unsafe.Pointer(&make([]byte, ownerSize)[0]))
1289 group = (*SID)(unsafe.Pointer(&make([]byte, groupSize)[0]))
1291 err = makeAbsoluteSD(selfRelativeSD, absoluteSD, &absoluteSDSize,
1292 dacl, &daclSize, sacl, &saclSize, owner, &ownerSize, group, &groupSize)
1296 // ToSelfRelative converts an absolute security descriptor into a self-relative one.
1297 func (absoluteSD *SECURITY_DESCRIPTOR) ToSelfRelative() (selfRelativeSD *SECURITY_DESCRIPTOR, err error) {
1298 control, _, err := absoluteSD.Control()
1302 if control&SE_SELF_RELATIVE != 0 {
1303 err = ERROR_INVALID_PARAMETER
1306 var selfRelativeSDSize uint32
1307 err = makeSelfRelativeSD(absoluteSD, nil, &selfRelativeSDSize)
1309 case ERROR_INSUFFICIENT_BUFFER:
1311 // makeSelfRelativeSD is expected to fail, but it succeeds.
1312 return nil, ERROR_INTERNAL_ERROR
1316 if selfRelativeSDSize > 0 {
1317 selfRelativeSD = (*SECURITY_DESCRIPTOR)(unsafe.Pointer(&make([]byte, selfRelativeSDSize)[0]))
1319 err = makeSelfRelativeSD(absoluteSD, selfRelativeSD, &selfRelativeSDSize)
1323 func (selfRelativeSD *SECURITY_DESCRIPTOR) copySelfRelativeSecurityDescriptor() *SECURITY_DESCRIPTOR {
1324 sdLen := (int)(selfRelativeSD.Length())
1327 h := (*unsafeheader.Slice)(unsafe.Pointer(&src))
1328 h.Data = unsafe.Pointer(selfRelativeSD)
1332 dst := make([]byte, sdLen)
1334 return (*SECURITY_DESCRIPTOR)(unsafe.Pointer(&dst[0]))
1337 // SecurityDescriptorFromString converts an SDDL string describing a security descriptor into a
1338 // self-relative security descriptor object allocated on the Go heap.
1339 func SecurityDescriptorFromString(sddl string) (sd *SECURITY_DESCRIPTOR, err error) {
1340 var winHeapSD *SECURITY_DESCRIPTOR
1341 err = convertStringSecurityDescriptorToSecurityDescriptor(sddl, 1, &winHeapSD, nil)
1345 defer LocalFree(Handle(unsafe.Pointer(winHeapSD)))
1346 return winHeapSD.copySelfRelativeSecurityDescriptor(), nil
1349 // GetSecurityInfo queries the security information for a given handle and returns the self-relative security
1350 // descriptor result on the Go heap.
1351 func GetSecurityInfo(handle Handle, objectType SE_OBJECT_TYPE, securityInformation SECURITY_INFORMATION) (sd *SECURITY_DESCRIPTOR, err error) {
1352 var winHeapSD *SECURITY_DESCRIPTOR
1353 err = getSecurityInfo(handle, objectType, securityInformation, nil, nil, nil, nil, &winHeapSD)
1357 defer LocalFree(Handle(unsafe.Pointer(winHeapSD)))
1358 return winHeapSD.copySelfRelativeSecurityDescriptor(), nil
1361 // GetNamedSecurityInfo queries the security information for a given named object and returns the self-relative security
1362 // descriptor result on the Go heap.
1363 func GetNamedSecurityInfo(objectName string, objectType SE_OBJECT_TYPE, securityInformation SECURITY_INFORMATION) (sd *SECURITY_DESCRIPTOR, err error) {
1364 var winHeapSD *SECURITY_DESCRIPTOR
1365 err = getNamedSecurityInfo(objectName, objectType, securityInformation, nil, nil, nil, nil, &winHeapSD)
1369 defer LocalFree(Handle(unsafe.Pointer(winHeapSD)))
1370 return winHeapSD.copySelfRelativeSecurityDescriptor(), nil
1373 // BuildSecurityDescriptor makes a new security descriptor using the input trustees, explicit access lists, and
1374 // prior security descriptor to be merged, any of which can be nil, returning the self-relative security descriptor
1375 // result on the Go heap.
1376 func BuildSecurityDescriptor(owner *TRUSTEE, group *TRUSTEE, accessEntries []EXPLICIT_ACCESS, auditEntries []EXPLICIT_ACCESS, mergedSecurityDescriptor *SECURITY_DESCRIPTOR) (sd *SECURITY_DESCRIPTOR, err error) {
1377 var winHeapSD *SECURITY_DESCRIPTOR
1378 var winHeapSDSize uint32
1379 var firstAccessEntry *EXPLICIT_ACCESS
1380 if len(accessEntries) > 0 {
1381 firstAccessEntry = &accessEntries[0]
1383 var firstAuditEntry *EXPLICIT_ACCESS
1384 if len(auditEntries) > 0 {
1385 firstAuditEntry = &auditEntries[0]
1387 err = buildSecurityDescriptor(owner, group, uint32(len(accessEntries)), firstAccessEntry, uint32(len(auditEntries)), firstAuditEntry, mergedSecurityDescriptor, &winHeapSDSize, &winHeapSD)
1391 defer LocalFree(Handle(unsafe.Pointer(winHeapSD)))
1392 return winHeapSD.copySelfRelativeSecurityDescriptor(), nil
1395 // NewSecurityDescriptor creates and initializes a new absolute security descriptor.
1396 func NewSecurityDescriptor() (absoluteSD *SECURITY_DESCRIPTOR, err error) {
1397 absoluteSD = &SECURITY_DESCRIPTOR{}
1398 err = initializeSecurityDescriptor(absoluteSD, 1)
1402 // ACLFromEntries returns a new ACL on the Go heap containing a list of explicit entries as well as those of another ACL.
1403 // Both explicitEntries and mergedACL are optional and can be nil.
1404 func ACLFromEntries(explicitEntries []EXPLICIT_ACCESS, mergedACL *ACL) (acl *ACL, err error) {
1405 var firstExplicitEntry *EXPLICIT_ACCESS
1406 if len(explicitEntries) > 0 {
1407 firstExplicitEntry = &explicitEntries[0]
1410 err = setEntriesInAcl(uint32(len(explicitEntries)), firstExplicitEntry, mergedACL, &winHeapACL)
1414 defer LocalFree(Handle(unsafe.Pointer(winHeapACL)))
1415 aclBytes := make([]byte, winHeapACL.aclSize)
1416 copy(aclBytes, (*[(1 << 31) - 1]byte)(unsafe.Pointer(winHeapACL))[:len(aclBytes):len(aclBytes)])
1417 return (*ACL)(unsafe.Pointer(&aclBytes[0])), nil