jcifs.smb

Class SID

java.lang.Object

jcifs.dcerpc.ndr.NdrObject

jcifs.dcerpc.rpc.sid_t

jcifs.smb.SID

public class SID
extends rpc.sid_t

A Windows SID is a numeric identifier used to represent Windows accounts. SIDs are commonly represented using a textual format such as S-1-5-21-1496946806-2192648263-3843101252-1029 but they may also be resolved to yield the name of the associated Windows account such as Administrators or MYDOM\alice.

Consider the following output of examples/SidLookup.java:

        toString: S-1-5-21-4133388617-793952518-2001621813-512
 toDisplayString: WNET\Domain Admins
         getType: 2
     getTypeText: Domain group
   getDomainName: WNET
  getAccountName: Domain Admins
 

Field Summary

Fields

Modifier and Type	Field and Description
static SID	CREATOR_OWNER Well known SID: CREATOR_OWNER
static SID	EVERYONE Well known SID: EVERYONE
static int	SID_FLAG_RESOLVE_SIDS
static int	SID_TYPE_ALIAS
static int	SID_TYPE_DELETED
static int	SID_TYPE_DOM_GRP
static int	SID_TYPE_DOMAIN
static int	SID_TYPE_INVALID
static int	SID_TYPE_UNKNOWN
static int	SID_TYPE_USE_NONE
static int	SID_TYPE_USER
static int	SID_TYPE_WKN_GRP
static SID	SYSTEM Well known SID: SYSTEM

Fields inherited from class jcifs.dcerpc.rpc.sid_t

identifier_authority, revision, sub_authority, sub_authority_count

Constructor Summary

Constructors

Constructor and Description
SID(byte[] src, int si) Construct a SID from it's binary representation.
SID(rpc.sid_t sid, int type, String domainName, String acctName, boolean decrementAuthority)
SID(SID domsid, int rid) Construct a SID from a domain SID and an RID (relative identifier).
SID(SID domsid, SID id) Construct a relative SID
SID(String textual) Construct a SID from it's textual representation such as S-1-5-21-1496946806-2192648263-3843101252-1029.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccountName() Return the sAMAccountName of this SID unless it could not be resolved in which case the numeric RID is returned.
String	getDomainName() Return the domain name of this SID unless it could not be resolved in which case the numeric representation is returned.
SID	getDomainSid()
SID[]	getGroupMemberSids(String authorityServerName, CIFSContext tc, int flags) Get members of the group represented by this SID, if it is one.
int	getRid() Get the RID This is the last subauthority identifier
int	getType() Returns the type of this SID indicating the state or type of account.
String	getTypeText() Return text represeting the SID type suitable for display to users.
int	hashCode()
boolean	isBlank()
boolean	isEmpty()
void	resolve(String authorityServerName, CIFSContext tc) Manually resolve this SID.
byte[]	toByteArray()
static byte[]	toByteArray(rpc.sid_t sid) Convert a sid_t to byte array
String	toDisplayString() Return a String representing this SID ideal for display to users.
String	toString() Return the numeric representation of this sid such as S-1-5-21-1496946806-2192648263-3843101252-1029.

Methods inherited from class jcifs.dcerpc.rpc.sid_t

decode, encode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SID_TYPE_USE_NONE

public static final int SID_TYPE_USE_NONE

See Also:

Constant Field Values

SID_TYPE_USER

public static final int SID_TYPE_USER

See Also:

Constant Field Values

SID_TYPE_DOM_GRP

public static final int SID_TYPE_DOM_GRP

See Also:

Constant Field Values

SID_TYPE_DOMAIN

public static final int SID_TYPE_DOMAIN

See Also:

Constant Field Values

SID_TYPE_ALIAS

public static final int SID_TYPE_ALIAS

See Also:

Constant Field Values

SID_TYPE_WKN_GRP

public static final int SID_TYPE_WKN_GRP

See Also:

Constant Field Values

SID_TYPE_DELETED

public static final int SID_TYPE_DELETED

See Also:

Constant Field Values

SID_TYPE_INVALID

public static final int SID_TYPE_INVALID

See Also:

Constant Field Values

SID_TYPE_UNKNOWN

public static final int SID_TYPE_UNKNOWN

See Also:

Constant Field Values

SID_FLAG_RESOLVE_SIDS

public static final int SID_FLAG_RESOLVE_SIDS

See Also:

Constant Field Values

EVERYONE

public static SID EVERYONE

Well known SID: EVERYONE

CREATOR_OWNER

public static SID CREATOR_OWNER

Well known SID: CREATOR_OWNER

SYSTEM

public static SID SYSTEM

Well known SID: SYSTEM

Constructor Detail

SID

public SID(byte[] src,
           int si)

Construct a SID from it's binary representation.

Parameters:

src -

si -

SID

public SID(String textual)
    throws SmbException

Construct a SID from it's textual representation such as S-1-5-21-1496946806-2192648263-3843101252-1029.

Parameters:

textual -

Throws:

SmbException

SID

public SID(SID domsid,
           int rid)

Construct a SID from a domain SID and an RID (relative identifier). For example, a domain SID S-1-5-21-1496946806-2192648263-3843101252 and RID 1029 would yield the SID S-1-5-21-1496946806-2192648263-3843101252-1029.

Parameters:

domsid -

rid -

SID

public SID(SID domsid,
           SID id)

Construct a relative SID

Parameters:

domsid -

id -

SID

public SID(rpc.sid_t sid,
           int type,
           String domainName,
           String acctName,
           boolean decrementAuthority)

Parameters:

sid -

type -

domainName -

acctName -

decrementAuthority -

Method Detail

toByteArray

public static byte[] toByteArray(rpc.sid_t sid)

Convert a sid_t to byte array

Parameters:

sid -

Returns:

byte encoded form

toByteArray

public byte[] toByteArray()

Returns:

encoded SID

isEmpty

public boolean isEmpty()

Returns:

whether the SID is empty (no sub-authorities)

isBlank

public boolean isBlank()

Returns:

whether the SID is blank (all sub-authorities zero)

getDomainSid

public SID getDomainSid()

Returns:

domain SID

getRid

public int getRid()

Get the RID This is the last subauthority identifier

Returns:

the RID

getType

public int getType()

Returns the type of this SID indicating the state or type of account.

SID types are described in the following table.

Type	Name
SID_TYPE_USE_NONE	0
SID_TYPE_USER	User
SID_TYPE_DOM_GRP	Domain group
SID_TYPE_DOMAIN	Domain
SID_TYPE_ALIAS	Local group
SID_TYPE_WKN_GRP	Builtin group
SID_TYPE_DELETED	Deleted
SID_TYPE_INVALID	Invalid
SID_TYPE_UNKNOWN	Unknown

Returns:

type code

getTypeText

public String getTypeText()

Return text represeting the SID type suitable for display to users. Text includes 'User', 'Domain group', 'Local group', etc.

Returns:

textual representation of type

getDomainName

public String getDomainName()

Return the domain name of this SID unless it could not be resolved in which case the numeric representation is returned.

Returns:

the domain name

getAccountName

public String getAccountName()

Return the sAMAccountName of this SID unless it could not be resolved in which case the numeric RID is returned. If this SID is a domain SID, this method will return an empty String.

Returns:

the account name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Return the numeric representation of this sid such as S-1-5-21-1496946806-2192648263-3843101252-1029.

Overrides:

toString in class Object

toDisplayString

public String toDisplayString()

Return a String representing this SID ideal for display to users. This method should return the same text that the ACL editor in Windows would display.

Specifically, if the SID has been resolved and it is not a domain SID or builtin account, the full DOMAIN\name form of the account will be returned (e.g. MYDOM\alice or MYDOM\Domain Users). If the SID has been resolved but it is is a domain SID, only the domain name will be returned (e.g. MYDOM). If the SID has been resolved but it is a builtin account, only the name component will be returned (e.g. SYSTEM). If the sid cannot be resolved the numeric representation from toString() is returned.

Returns:

display format, potentially with resolved names

resolve

public void resolve(String authorityServerName,
                    CIFSContext tc)
             throws IOException

Manually resolve this SID. Normally SIDs are automatically resolved. However, if a SID is constructed explicitly using a SID constructor, JCIFS will have no knowledge of the server that created the SID and therefore cannot possibly resolve it automatically. In this case, this method will be necessary.

Parameters:

authorityServerName - The FQDN of the server that is an authority for the SID.

tc - Context to use

Throws:

IOException

getGroupMemberSids

public SID[] getGroupMemberSids(String authorityServerName,
                                CIFSContext tc,
                                int flags)
                         throws IOException

Get members of the group represented by this SID, if it is one.

Parameters:

authorityServerName -

tc -

flags -

Returns:

the members of the group

Throws:

IOException