Class SIPAuthorisationDigest
Class for the SIP authorization digest
Inherited Members
Namespace: SipLib.Core
Assembly: SipLib.dll
Syntax
public class SIPAuthorisationDigest
Constructors
| Edit this page View SourceSIPAuthorisationDigest()
Constructor
Declaration
public SIPAuthorisationDigest()
SIPAuthorisationDigest(SIPAuthorisationHeadersEnum)
Constructor
Declaration
public SIPAuthorisationDigest(SIPAuthorisationHeadersEnum authorisationType)
Parameters
| Type | Name | Description |
|---|---|---|
| SIPAuthorisationHeadersEnum | authorisationType | Specifies the type of authorization/authentication |
SIPAuthorisationDigest(SIPAuthorisationHeadersEnum, string, string, string, string, string, string)
Constructor
Declaration
public SIPAuthorisationDigest(SIPAuthorisationHeadersEnum authorisationType, string realm, string username, string password, string uri, string nonce, string request)
Parameters
| Type | Name | Description |
|---|---|---|
| SIPAuthorisationHeadersEnum | authorisationType | |
| string | realm | |
| string | username | |
| string | password | |
| string | uri | |
| string | nonce | |
| string | request |
Fields
| Edit this page View SourceAUTH_ALGORITHM
MD5 authorization algorithm
Declaration
public const string AUTH_ALGORITHM = "MD5"
Field Value
| Type | Description |
|---|---|
| string |
Algorithhm
Algorithm value
Declaration
public string Algorithhm
Field Value
| Type | Description |
|---|---|
| string |
Cnonce
Client nonce (used with WWW-Authenticate and qop=auth).
Declaration
public string Cnonce
Field Value
| Type | Description |
|---|---|
| string |
DestinationURL
Destination URL value
Declaration
public string DestinationURL
Field Value
| Type | Description |
|---|---|
| string |
Nonce
Nonce value
Declaration
public string Nonce
Field Value
| Type | Description |
|---|---|
| string |
Opaque
Opaque value
Declaration
public string Opaque
Field Value
| Type | Description |
|---|---|
| string |
Password
Password value
Declaration
public string Password
Field Value
| Type | Description |
|---|---|
| string |
QOP_AUTHENTICATION_VALUE
QOP authentication value
Declaration
public const string QOP_AUTHENTICATION_VALUE = "auth"
Field Value
| Type | Description |
|---|---|
| string |
Qop
Quality of Protection. Values permitted are auth (authentication) and auth-int (authentication with integrity protection).
Declaration
public string Qop
Field Value
| Type | Description |
|---|---|
| string |
Realm
Realm value
Declaration
public string Realm
Field Value
| Type | Description |
|---|---|
| string |
RequestType
Request type value
Declaration
public string RequestType
Field Value
| Type | Description |
|---|---|
| string |
Response
Response value
Declaration
public string Response
Field Value
| Type | Description |
|---|---|
| string |
URI
URI value
Declaration
public string URI
Field Value
| Type | Description |
|---|---|
| string |
Username
User name value
Declaration
public string Username
Field Value
| Type | Description |
|---|---|
| string |
Properties
| Edit this page View SourceAuthorisationResponseType
If this is set it's the type of authorisation response to use otherwise use the same as the request
Declaration
public SIPAuthorisationHeadersEnum AuthorisationResponseType { get; }
Property Value
| Type | Description |
|---|---|
| SIPAuthorisationHeadersEnum |
AuthorisationType
This is the type of authorisation request received.
Declaration
public SIPAuthorisationHeadersEnum AuthorisationType { get; }
Property Value
| Type | Description |
|---|---|
| SIPAuthorisationHeadersEnum |
Digest
Gets the digest value
Declaration
public string Digest { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
| Edit this page View SourceParseAuthorisationDigest(SIPAuthorisationHeadersEnum, string)
Parses an authorization digitest
Declaration
public static SIPAuthorisationDigest ParseAuthorisationDigest(SIPAuthorisationHeadersEnum authorisationType, string authorisationRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| SIPAuthorisationHeadersEnum | authorisationType | Authorization type |
| string | authorisationRequest |
Returns
| Type | Description |
|---|---|
| SIPAuthorisationDigest |
SetCredentials(string, string, string, string)
Sets the credentials
Declaration
public void SetCredentials(string username, string password, string uri, string method)
Parameters
| Type | Name | Description |
|---|---|---|
| string | username | |
| string | password | |
| string | uri | |
| string | method |
ToString()
Converts the authorization digest to a string
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string |