SecurityTokenService Klasa

Definicja

public ref class SecurityTokenService abstract

public abstract class SecurityTokenService

type SecurityTokenService = class

Public MustInherit Class SecurityTokenService

Dziedziczenie

Object

SecurityTokenService

Przykłady

Przykłady kodu używane w tematach SecurityTokenService pochodzą z przykładu Custom Token . Ten przykład zawiera klasy niestandardowe, które umożliwiają przetwarzanie prostych tokenów internetowych (SWT) i obejmują implementację pasywnego stS, który może obsługiwać token SWT. Przykład implementacji aktywnej usługi STS można znaleźć w przykładzie Federation Metadata . Aby uzyskać informacje o tych przykładach i innych przykładach dostępnych dla programu WIF oraz o tym, gdzie je pobrać, zobacz Przykładowy indeks kodu programu WIF. Poniższy kod przedstawia implementację pasywnej usługi STS przy użyciu SecurityTokenService klasy .

using System;
using System.IdentityModel;
using System.IdentityModel.Configuration;
using System.IdentityModel.Protocols.WSTrust;
using System.IdentityModel.Tokens;
using System.Security.Claims;
using System.Security.Cryptography.X509Certificates;

namespace PassiveSTS
{
    /// <summary>
    /// Overrides the SecurityTokenService class to provide
    /// the relying party related information, such as encryption credentials to encrypt the issued
    /// token, signing credentials to sign the issued token, claims that the STS wants to issue for a 
    /// certain token request, as well as the claim types that this STS is capable
    /// of issuing.
    /// </summary>
    public class CustomSecurityTokenService : SecurityTokenService
    {
        // Certificate Constants
        private const string SIGNING_CERTIFICATE_NAME = "CN=localhost";
        private const string ENCRYPTING_CERTIFICATE_NAME = "CN=localhost";

        private SigningCredentials _signingCreds;
        private EncryptingCredentials _encryptingCreds;
        // Used for validating applies to address, set to URI used in RP app of application, could also have been done via config
        private string _addressExpected = "http://localhost:19851/";
        public CustomSecurityTokenService(SecurityTokenServiceConfiguration configuration)
            : base(configuration)
        {
            // Setup the certificate our STS is going to use to sign the issued tokens
            _signingCreds = new X509SigningCredentials(CertificateUtil.GetCertificate(StoreName.My, StoreLocation.LocalMachine, SIGNING_CERTIFICATE_NAME));

            // Note: In this sample app only a si   ngle RP identity is shown, which is localhost, and the certificate of that RP is 
            // populated as _encryptingCreds
            // If you have multiple RPs for the STS you would select the certificate that is specific to 
            // the RP that requests the token and then use that for _encryptingCreds
            _encryptingCreds = new X509EncryptingCredentials(CertificateUtil.GetCertificate(StoreName.My, StoreLocation.LocalMachine, ENCRYPTING_CERTIFICATE_NAME));
        }

        /// <summary>
        /// This method returns the configuration for the token issuance request. The configuration
        /// is represented by the Scope class. In our case, we are only capable of issuing a token to a
        /// single RP identity represented by the _encryptingCreds field.
        /// </summary>
        /// <param name="principal">The caller's principal</param>
        /// <param name="request">The incoming RST</param>
        /// <returns></returns>
        protected override Scope GetScope(ClaimsPrincipal principal, RequestSecurityToken request)
        {
            // Validate the AppliesTo address
            ValidateAppliesTo( request.AppliesTo );

            // Create the scope using the request AppliesTo address and the RP identity
            Scope scope = new Scope( request.AppliesTo.Uri.AbsoluteUri, _signingCreds );

            if (Uri.IsWellFormedUriString(request.ReplyTo, UriKind.Absolute))
            {
                if (request.AppliesTo.Uri.Host != new Uri(request.ReplyTo).Host)
                    scope.ReplyToAddress = request.AppliesTo.Uri.AbsoluteUri;
                else
                    scope.ReplyToAddress = request.ReplyTo;
            }
            else
            {
                Uri resultUri = null;
                if (Uri.TryCreate(request.AppliesTo.Uri, request.ReplyTo, out resultUri))
                    scope.ReplyToAddress = resultUri.AbsoluteUri;
                else
                    scope.ReplyToAddress = request.AppliesTo.Uri.ToString() ;
            }

            // Note: In this sample app only a single RP identity is shown, which is localhost, and the certificate of that RP is 
            // populated as _encryptingCreds
            // If you have multiple RPs for the STS you would select the certificate that is specific to 
            // the RP that requests the token and then use that for _encryptingCreds
            scope.EncryptingCredentials = _encryptingCreds;

            return scope;
        }
        /// <summary>
        /// This method returns the content of the issued token. The content is represented as a set of
        /// IClaimIdentity intances, each instance corresponds to a single issued token. Currently, the Windows Identity Foundation only
        /// supports a single token issuance, so the returned collection must always contain only a single instance.
        /// </summary>
        /// <param name="scope">The scope that was previously returned by GetScope method</param>
        /// <param name="principal">The caller's principal</param>
        /// <param name="request">The incoming RST, we don't use this in our implementation</param>
        /// <returns></returns>
        protected override ClaimsIdentity GetOutputClaimsIdentity( ClaimsPrincipal principal, RequestSecurityToken request, Scope scope )
        {
            //
            // Return a default claim set which contains a custom decision claim
            // Here you can actually examine the user by looking at the IClaimsPrincipal and 
            // return the right decision based on that. 
            //
            ClaimsIdentity outgoingIdentity = new ClaimsIdentity();
            outgoingIdentity.AddClaims(principal.Claims);

            return outgoingIdentity;
        }
        /// <summary>
        /// Validates the appliesTo and throws an exception if the appliesTo is null or appliesTo contains some unexpected address.
        /// </summary>
        /// <param name="appliesTo">The AppliesTo parameter in the request that came in (RST)</param>
        /// <returns></returns>
        void ValidateAppliesTo(EndpointReference appliesTo)
        {
            if (appliesTo == null)
            {
                throw new InvalidRequestException("The appliesTo is null.");
            }

            if (!appliesTo.Uri.Equals(new Uri(_addressExpected)))
            {
                throw new InvalidRequestException(String.Format("The relying party address is not valid. Expected value is {0}, the actual value is {1}.", _addressExpected, appliesTo.Uri.AbsoluteUri));
            }
        }

    }
}

Poniższy kod pokazuje, jak wywołać niestandardową pasywną usługę STS w celu przetworzenia żądania WS-Federation przez wywołanie FederatedPassiveSecurityTokenServiceOperations.ProcessRequest(HttpRequest, ClaimsPrincipal, SecurityTokenService, HttpResponse) metody z kodu w default.aspx.cs pliku.

using System;
using System.IdentityModel.Services;
using System.Security.Claims;

namespace PassiveSTS
{
    public partial class _Default : System.Web.UI.Page
    {
        /// <summary>
        /// We perform the WS-Federation Passive Protocol processing in this method. 
        /// </summary>
        protected void Page_PreRender( object sender, EventArgs e ) 
        {
            FederatedPassiveSecurityTokenServiceOperations.ProcessRequest( Request, User as ClaimsPrincipal, CustomSecurityTokenServiceConfiguration.Current.CreateSecurityTokenService(), Response );
        }
    }
}

Uwagi

Aby utworzyć usługę STS, musisz pochodzić z SecurityTokenService klasy . W klasie niestandardowej należy co najmniej zastąpić GetScope metody i GetOutputClaimsIdentity . W przypadku tych przesłonięć usługa STS utworzona przy użyciu domyślnej implementacji wszystkich innych metod zdefiniowanych w klasie może wystawiać tokeny zabezpieczające w odpowiedzi na żądania tokenu zabezpieczającego (RST). Oznacza to, że powiązanie problemu zdefiniowane w specyfikacji WS-Trust jest implementowane. To powiązanie jest implementowane w metodzie Issue . Żadne z innych powiązań WS-Trust (Odnów, Anuluj i Zweryfikuj) nie są implementowane w domyślnym przypadku, a odpowiedni błąd jest zwracany do obiektu wywołującego, jeśli napotkany jest RST odpowiadający jednemu z tych powiązań. Można oczywiście zastąpić odpowiednie metody (Renew, Cancel, i Validate), aby zaimplementować te powiązania w usłudze STS.

Poniższa lista zawiera krótkie omówienie metod o podstawowym znaczeniu dla dewelopera do użycia w środowisku testowym lub programistycznym.

• Metoda GetScope. Ta metoda zwraca Scope obiekt zawierający informacje o rp. Ten obiekt jest używany w pozostałej części potoku wystawiania tokenu i zawiera informacje o podpisywaniu i szyfrowaniu poświadczeń do użycia w odpowiedzi, a także AppliesTo adresy i ReplyTo (jeśli jest to wymagane). Tę metodę należy zastąpić.

• Metoda GetOutputClaimsIdentity. Ta metoda zwraca ClaimsIdentity obiekt, który zawiera oświadczenia, które mają wrócić do żądania ściąggowania. Tę metodę należy zastąpić.

• Metoda Issue. Ta metoda implementuje potok żądania tokenu, który przetwarza przychodzące żądanie tokenu zabezpieczającego (RST) i zwraca odpowiedź (RSTR) do obiektu wywołującego zawierającego token, który może służyć do uwierzytelniania za pomocą dostawcy zasobów. Wiele innych metod zdefiniowanych w SecurityTokenService klasie jest wywoływanych z tej metody, w tym GetScope metod i GetOutputClaimsIdentity . Nie trzeba zastępować tej metody, ale pomocne może być zrozumienie potoku żądania tokenu, który implementuje.

Usługa STS jest konfigurowana za pomocą SecurityTokenServiceConfiguration klasy .

Notatki dotyczące implementowania

Należy zastąpić metody GetScope(ClaimsPrincipal, RequestSecurityToken) i GetOutputClaimsIdentity(ClaimsPrincipal, RequestSecurityToken, Scope) .

Zobacz też

• Scope
• SecurityTokenServiceConfiguration
• FederatedPassiveSecurityTokenServiceOperations