SecurityTokenParameters Class

Definition

Namespace:

System.ServiceModel.Security.Tokens

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.1

Source:

SecurityTokenParameters.cs

Specifies an abstract class that when implemented represents security token parameters.

C#

public abstract class SecurityTokenParameters

Inheritance

Object

SecurityTokenParameters

Derived

System.ServiceModel.Security.Tokens.IssuedSecurityTokenParameters

System.ServiceModel.Security.Tokens.KerberosSecurityTokenParameters

System.ServiceModel.Security.Tokens.RsaSecurityTokenParameters

System.ServiceModel.Security.Tokens.SecureConversationSecurityTokenParameters

System.ServiceModel.Security.Tokens.SslSecurityTokenParameters

System.ServiceModel.Security.Tokens.SspiSecurityTokenParameters

System.ServiceModel.Security.Tokens.UserNameSecurityTokenParameters

System.ServiceModel.Security.Tokens.X509SecurityTokenParameters

Examples

The following code shows a custom override of this class called CreditCardTokenParameters.

C#

public class CreditCardTokenParameters : SecurityTokenParameters
{
    public CreditCardTokenParameters()
    {
    }

    protected CreditCardTokenParameters(CreditCardTokenParameters other)
        : base(other)
    {
    }

    protected override SecurityTokenParameters CloneCore()
    {
        return new CreditCardTokenParameters(this);
    }

    protected override void InitializeSecurityTokenRequirement(SecurityTokenRequirement requirement)
    {
        requirement.TokenType = Constants.CreditCardTokenType;
        return;
    }

    // A credit card token has no cryptography, no windows identity, and supports only client authentication.
    protected override bool HasAsymmetricKey
    {
        get { return false; }
    }

    protected override bool SupportsClientAuthentication
    {
        get { return true; }
    }

    protected override bool SupportsClientWindowsIdentity
    {
        get { return false; }
    }

    protected override bool SupportsServerAuthentication
    {
        get { return false; }
    }

    protected override SecurityKeyIdentifierClause CreateKeyIdentifierClause(SecurityToken token, SecurityTokenReferenceStyle referenceStyle)
    {
        if (referenceStyle == SecurityTokenReferenceStyle.Internal)
        {
            return token.CreateKeyIdentifierClause<LocalIdKeyIdentifierClause>();
        }
        else
        {
            throw new NotSupportedException("External references are not supported for credit card tokens");
        }
    }
}

Remarks

Security token parameters provide information about the tokens (for example, token type, issuer, and so on) required by the security binding element.

The security token parameter classes derived from this one are a collection of token properties and methods, and are used in creating different kinds of security binding elements and tokens. Not all of the properties are relevant to all derived classes. For example, the ReferenceStyle has no relevance in an issued token (SAML token) case.

Constructors

SecurityTokenParameters()	Initializes a new instance of the SecurityTokenParameters class.
SecurityTokenParameters(SecurityTokenParameters)	Initializes a new instance of the SecurityTokenParameters class from another instance.

Properties

HasAsymmetricKey	When overridden in a derived class, gets a value that indicates whether the token has an asymmetric key.
InclusionMode	Gets or sets the token inclusion requirements.
RequireDerivedKeys	Gets or sets a value that indicates whether keys can be derived from the original proof keys.
SupportsClientAuthentication	When overridden in a derived class, gets a value that indicates whether the token supports client authentication.
SupportsClientWindowsIdentity	When overridden in a derived class, gets a value that indicates whether the token supports a Windows identity for authentication.
SupportsServerAuthentication	When overridden in a derived class, gets a value that indicates whether the token supports server authentication.

Methods

Clone()	Clones another instance of this instance of the class.
CloneCore()	Clones another instance of this instance of the class.
CreateKeyIdentifierClause(SecurityToken, SecurityTokenReferenceStyle)	Creates a key identifier clause for a token.
InitializeSecurityTokenRequirement(SecurityTokenRequirement)	When overridden in a derived class, initializes a security token requirement.
MatchesKeyIdentifierClause(SecurityToken, SecurityKeyIdentifierClause, SecurityTokenReferenceStyle)	Indicates whether a token matches a key identifier clause.
ToString()	Displays a text representation of this instance of the class.

Applies to