SPPassiveIssuerTokenResolver.TryResolveSecurityKeyCore method

Retrieves the key that is referenced in the specified key identifier clause.

Namespace:  Microsoft.SharePoint.IdentityModel
Assembly:  Microsoft.SharePoint.IdentityModel (in Microsoft.SharePoint.IdentityModel.dll)

Syntax

'Declaration
Protected Overrides Function TryResolveSecurityKeyCore ( _
    keyIdentifierClause As SecurityKeyIdentifierClause, _
    <OutAttribute> ByRef key As SecurityKey _
) As Boolean
'Usage
Dim keyIdentifierClause As SecurityKeyIdentifierClause
Dim key As SecurityKey
Dim returnValue As Boolean

returnValue = Me.TryResolveSecurityKeyCore(keyIdentifierClause, _
    key)

protected override bool TryResolveSecurityKeyCore(
    SecurityKeyIdentifierClause keyIdentifierClause,
    out SecurityKey key
)

Parameters

• keyIdentifierClause
  Type: System.IdentityModel.Tokens.SecurityKeyIdentifierClause

  The key identifier clause for which the key is retrieved.

• key
  Type: System.IdentityModel.Tokens.SecurityKey

  When this method returns, contains the key that is referenced in the key identifier clause. This parameter is passed uninitialized.

Return value

Type: System.Boolean
true if a key can be retrieved for the specified key identifier clause; otherwise, false.

Exceptions

Exception	Condition
ArgumentNullException	keyIdentifierClause is null .

Remarks

If the keyIdentifierClause property value is encrypted, this override returns key as a InMemorySymmetricSecurityKey by decrypting the security key in the clause; otherwise, this override returns the first security key in the security token resolved from the clause, or creates a new key if the clause cannot be resolved to a security token.

See also

Reference

SPPassiveIssuerTokenResolver class

SPPassiveIssuerTokenResolver members

Microsoft.SharePoint.IdentityModel namespace