WindowsClaimsIdentity.CreateFromCertificate Method (X509Certificate2, Boolean, String)
[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]
Creates a new instance of WindowsClaimsIdentity class from an x509 certificate and the specified issuer.
Namespace: Microsoft.IdentityModel.Claims
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)
Usage
'Usage
Dim certificate As X509Certificate2
Dim useWindowsTokenService As Boolean
Dim issuerName As String
Dim returnValue As WindowsClaimsIdentity
returnValue = WindowsClaimsIdentity.CreateFromCertificate(certificate, useWindowsTokenService, issuerName)
Syntax
'Declaration
Public Shared Function CreateFromCertificate ( _
certificate As X509Certificate2, _
useWindowsTokenService As Boolean, _
issuerName As String _
) As WindowsClaimsIdentity
public static WindowsClaimsIdentity CreateFromCertificate (
X509Certificate2 certificate,
bool useWindowsTokenService,
string issuerName
)
public:
static WindowsClaimsIdentity^ CreateFromCertificate (
X509Certificate2^ certificate,
bool useWindowsTokenService,
String^ issuerName
)
public static WindowsClaimsIdentity CreateFromCertificate (
X509Certificate2 certificate,
boolean useWindowsTokenService,
String issuerName
)
public static function CreateFromCertificate (
certificate : X509Certificate2,
useWindowsTokenService : boolean,
issuerName : String
) : WindowsClaimsIdentity
Parameters
- certificate
The certificate to draw the Upn claim from to use to map to the associated WindowsClaimsIdentity.
- useWindowsTokenService
If true this method will perform an S4U logon executed in the context of the trusted token service. If false, the method performs the logon by invoking CertificateLogon.
- issuerName
The name of the issuer to use for the claims associated with the WindowsClaimsIdentity.
Return Value
A WindowsClaimsIdentity representing the user associated with the UPN in the certificate.
Remarks
If configured, the Windows Token Service will be utilized to ensure that this WindowsClaimsIdentity allows impersonation. The Issuer property of the user’s claims will be set to issuerName.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Target Platforms
Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)
See Also
Reference
WindowsClaimsIdentity Class
WindowsClaimsIdentity Members
Microsoft.IdentityModel.Claims Namespace
Other Resources
Claims to Windows Token Service (c2WTS) Overview
Copyright © 2008 by Microsoft Corporation. All rights reserved.