net.tirasa.adsddl.ntsd

Class SID

java.lang.Object

net.tirasa.adsddl.ntsd.SID

public class SID
extends java.lang.Object

A security identifier (SID) uniquely identifies a security principal. Each security principal has a unique SID that is issued by a security agent. The agent can be a Windows local system or domain. The agent generates the SID when the security principal is created. The SID can be represented as a character string or as a structure. When represented as strings, for example in documentation or logs, SIDs are expressed as follows: S-1-IdentifierAuthority-SubAuthority1-SubAuthority2-...-SubAuthorityn The top-level issuer is the authority. Each issuer specifies, in an implementation-specific manner, how many integers identify the next issuer. A newly created account store is assigned a 96-bit identifier (a cryptographic strength (pseudo) random number). A newly created security principal in an account store is assigned a 32-bit identifier that is unique within the store. The last item in the series of SubAuthority values is known as the relative identifier (RID). Differences in the RID are what distinguish the different SIDs generated within a domain. Consumers of SIDs SHOULD NOT rely on anything more than that the SID has the appropriate structure.

See Also:

cc230371, gg465313

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG Logger.

Method Summary

Modifier and Type	Method and Description
SID	addSubAuthority(byte[] sub) Adds sub-authority:a principal relative to the IdentifierAuthority.
boolean	equals(java.lang.Object sid)
byte[]	getIdentifierAuthority() Gets identifier authority: 6 bytes describing the entity that created the SID.
byte	getRevision() Gets revision level of the SID.
int	getSize() Gets size of the SID byte array form.
java.util.List<byte[]>	getSubAuthorities() Gets sub-authorities: a list of unsigned 32-bit integers that uniquely identifies a principal relative to the IdentifierAuthority.
int	getSubAuthorityCount() Gets sub-authority number: an 8-bit unsigned integer that specifies the number of elements in the SubAuthority array.
int	hashCode()
static SID	newInstance(byte[] identifier) Instances a new SID with the given identifier authority.
static SID	parse(byte[] src) Instances a SID instance of the given byte array.
SID	setIdentifierAuthority(byte[] identifierAuthority) Sets idetifier authority: 6 bytes describing the entity that created the SID.
SID	setRevision(byte revision) Sets revision level of the SID.
byte[]	toByteArray() Serializes to byte array.
java.lang.String	toString() Serializes to string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Logger.

Method Detail

newInstance

public static SID newInstance(byte[] identifier)

Instances a new SID with the given identifier authority.

Parameters:

identifier - identifier authority (6 bytes only).

Returns:

the SID instance.

parse

public static SID parse(byte[] src)

Instances a SID instance of the given byte array.

Parameters:

src - SID as byte array.

Returns:

SID instance.

getRevision

public byte getRevision()

Gets revision level of the SID.

Returns:

revision.

getSubAuthorityCount

public int getSubAuthorityCount()

Gets sub-authority number: an 8-bit unsigned integer that specifies the number of elements in the SubAuthority array. The maximum number of elements allowed is 15.

Returns:

sub-authorities number.

getIdentifierAuthority

public byte[] getIdentifierAuthority()

Gets identifier authority: 6 bytes describing the entity that created the SID.

Returns:

identifier authority.

getSubAuthorities

public java.util.List<byte[]> getSubAuthorities()

Gets sub-authorities: a list of unsigned 32-bit integers that uniquely identifies a principal relative to the IdentifierAuthority.

Returns:

sub-authorities.

getSize

public int getSize()

Gets size of the SID byte array form.

Returns:

size of SID byte aray form.

setRevision

public SID setRevision(byte revision)

Sets revision level of the SID.

Parameters:

revision - revision.

Returns:

the current SID instance.

setIdentifierAuthority

public SID setIdentifierAuthority(byte[] identifierAuthority)

Sets idetifier authority: 6 bytes describing the entity that created the SID.

Parameters:

identifierAuthority - identifier authority.

Returns:

the current SID instance.

addSubAuthority

public SID addSubAuthority(byte[] sub)

Adds sub-authority:a principal relative to the IdentifierAuthority.

Parameters:

sub - sub-authority.

Returns:

the current SID instance.

toByteArray

public byte[] toByteArray()

Serializes to byte array.

Returns:

serialized SID.

toString

public java.lang.String toString()

Serializes to string.

Overrides:

toString in class java.lang.Object

Returns:

serialized SID.

equals

public boolean equals(java.lang.Object sid)

Overrides:

equals in class java.lang.Object

Parameters:

sid - SID to be compared with.

Returns:

true if equals; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

hashcode.