AuthenticationInfo
The AuthenticationInfo structure contains a security context for a SIP message, as well as a set of Boolean properties that describe the connection type and authentication.
This structure is automatically populated whenever a Request Sip Class or Response Sip Class message object is dispatched to the application, and is referenced by the Message.AuthenticationInfo read-only property inherited by both message types.
Public Methods
The AuthenticationInfo structure has the following public methods.
|
Method |
Description |
|---|---|
|
Equals(Object) |
Inherited from System.ValueType. Indicates whether this instance and a specified object are equal. |
|
GetHashCode() |
Inherited from System.ValueType. Returns the hash code for this instance. |
|
GetType() |
Inherited from System.Object. Gets the Type of the current instance. |
|
ToString() |
Inherited from System.ValueType. Returns the fully qualified type name of this instance. |
Public Properties
The AuthenticationInfo structure has the following public properties.
|
Property |
Description |
|---|---|
|
Authenticated |
Data type: BooleanAccess type: Read-only. Indicates whether the message sender has been authenticated. |
|
CertificateAuthorized |
Data type: BooleanAccess type: Read-only. Indicates whether the certificate from the message sender is validated by a certificate signing authority. |
|
ConnectionAuthorizationEnabled |
Data type: BooleanAccess type: Read-only. Indicates whether authorization is enabled for the connection by which the message arrived. |
|
ExternalSourceNetwork |
Data type: ExternalSourceNetworkAccess type: Read-only. Enumeration that indicates the type of network from which the message originated. Valid if the message arrived from the external network. Valid on Internal servers only. |
|
ExternalSourceType |
Data type: ExternalSourceTypeAccess type: Read-only. Enumeration that indicates the nature of the source of the message. Valid if the message arrived from the external network. Valid on Internal servers only. |
|
MtlsConnection |
Data type: BooleanAccess type: Read-only Indicates whether the message was received over a Mutually authenticated Transport Layer Security (MTLS) connection. |
|
Origin |
Data type: MessageOriginAccess type: Read-only. Specifies the origin of a SIP message. |
|
ReceivedFromInternalServer |
Data type: BooleanAccess type: Read-only. Indicates whether the message was received from an internal server. |
|
SecurityToken |
Data type: IntPtrAccess type: Read-only. Contains a Win32 handle for the security token of the message sender as an IntPtr. |
|
TlsPeer |
Data type: StringAccess type: Read-only Captures the fully qualified domain name (FQDN) of the previous hop from which the message was received. |
|
TrustedConnection |
Data type: BooleanAccess type: Read-only. Indicates whether the message was received over a trusted connection. |
Protected Methods
The AuthenticationInfo structure has the following protected methods.
|
Method |
Description |
|---|---|
|
Finalize() |
Inherited from System.Object. Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
|
MemberwiseClone() |
Inherited from System.Object. Creates a shallow copy of the current Object. |
Requirements
Redistributable: Requires Microsoft Lync Server 2010
Namespace:Microsoft.Rtc.Sip
Assembly: ServerAgent (in ServerAgent.dll)
