web-eid-authtoken-validation-dotnet is a .NET library for issuing challenge nonces and validating Web eID JWT authentication tokens during secure authentication with electronic ID (eID) smart cards in web applications.
More information about the Web eID project is available on the project website.
Complete the steps below to add support for secure authentication with eID cards to your ASP.NET Core web application back end. Instructions for the front end are available here.
See full example here.
To install the package, you can use the Package Manager Console.
- Select the Tools > NuGet Package Manager > Package Manager Console menu command.
- Once the console opens, check that the Default project drop-down list shows the project into which you want to install the package. If you have a single project in the solution, it is already selected.
- Enter the following commands:
Add-Source -Name "Web eID GitLab" -Source "https://gitlab.com/api/v4/projects/35362906/packages/nuget/index.json" Install-Package WebEid.Security
When you install a package, NuGet records the dependency in either your project file or a packages.config file (depending on the project format).
The validation library needs a store for saving the issued challenge nonces. As it must be guaranteed that the authentication token is received from the same browser to which the corresponding challenge nonce was issued, using a session-backed challenge nonce store is the most natural choice.
Implement the session-backed challenge nonce store as follows:
using Microsoft.AspNetCore.Http;
using System.Text.Json;
using WebEid.Security.Challenge;
public class SessionBackedChallengeNonceStore : IChallengeNonceStore
{
private const string ChallengeNonceKey = "challenge-nonce";
private readonly IHttpContextAccessor httpContextAccessor;
public SessionBackedChallengeNonceStore(IHttpContextAccessor httpContextAccessor)
{
this.httpContextAccessor = httpContextAccessor;
}
public void Put(ChallengeNonce challengeNonce)
{
this.httpContextAccessor.HttpContext.Session.SetString(ChallengeNonceKey, JsonSerializer.Serialize(challengeNonce));
}
public ChallengeNonce GetAndRemoveImpl()
{
var httpContext = this.httpContextAccessor.HttpContext;
var challenceNonceJson = httpContext.Session.GetString(ChallengeNonceKey);
if (!string.IsNullOrWhiteSpace(challenceNonceJson))
{
httpContext.Session.Remove(ChallengeNonceKey);
return JsonSerializer.Deserialize<ChallengeNonce>(challenceNonceJson);
}
return null;
}
}The IHttpContextAccessor dependency of SessionBackedChallengeNonceStore must be configured in the ASP.NET Startup class:
services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();The validation library needs to generate authentication challenge nonces and store them for later validation in the challenge nonce store. Overview of challenge nonce usage is provided in the Web eID system architecture document. The challenge nonce generator will be used in the REST endpoint that issues challenges; it is thread-safe and should be scoped as a singleton.
Configure the challenge nonce generator and its dependencies in the ASP.NET Startup class as follows:
public void ConfigureServices(IServiceCollection services)
{
...
services.AddSingleton(RandomNumberGenerator.Create());
services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
services.AddSingleton<IChallengeNonceStore, SessionBackedChallengeNonceStore>();
services.AddSingleton<IChallengeNonceGenerator, ChallengeNonceGenerator>();
...
}You must explicitly specify which intermediate certificate authorities (CAs) are trusted to issue the eID authentication certificates. CA certificates can be loaded from either the resources or any stream source.
First implement CertificateLoader class:
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Security.Cryptography.X509Certificates;
internal static class CertificateLoader
{
public static X509Certificate[] LoadTrustedCaCertificatesFromStore()
{
var certPath = "Certificates";
return new FileReader(certPath, "*.cer").ReadFiles()
.Select(file => new X509Certificate(file))
.ToArray();
}
}
internal class FileReader
{
private readonly string path;
private readonly string searchPattern;
public FileReader(string path, string searchPattern = null)
{
this.path = path;
this.searchPattern = searchPattern;
}
public IEnumerable<byte[]> ReadFiles()
{
foreach (var file in Directory.EnumerateFiles(this.path, this.searchPattern))
{
yield return File.ReadAllBytes(file);
}
}
}Then copy the trusted certificates, for example ESTEID-SK_2015.cer and ESTEID2018.cer, to Certificates and load the certificates as follows:
...
private X509Certificate[] TrustedCertificateAuthorities()
{
CertificateLoader.LoadTrustedCaCertificatesFromStore();
}
...Once the prerequisites have been met, the authentication token validator itself can be configured. The mandatory parameters are the website origin (the URL serving the web application), challenge nonce cache and trusted certificate authorities. The authentication token validator will be used in the login processing component of your web application authentication framework; it is thread-safe and should be scoped as a singleton.
using Security.Validator;
...
public AuthTokenValidator TokenValidator()
{
return new AuthTokenValidatorBuilder()
.WithSiteOrigin("https://example.org")
.WithTrustedCertificateAuthorities(TrustedCertificateAuthorities())
.Build();
}
...A REST endpoint that issues challenge nonces is required for authentication. The endpoint must support GET requests.
In the following example, we are using the ASP.NET Web APIs RESTful Web Services framework to implement the endpoint, see also full implementation here.
using Microsoft.AspNetCore.Mvc;
using WebEid.Security.Nonce;
[ApiController]
[Route("auth")]
public class ChallengeController : ControllerBase
{
private readonly IChallengeNonceGenerator challengeNonceGenerator;
public ChallengeController(IChallengeNonceGenerator challengeNonceGenerator)
{
this.challengeNonceGenerator = challengeNonceGenerator;
}
[HttpGet]
[Route("challenge")]
public ChallengeDto GetChallenge()
{
var challenge = new ChallengeDto
{
Nonce = challengeNonceGenerator.GenerateAndStoreNonce(TimeSpan.FromMinutes(5)).Base64EncodedNonce
};
return challenge;
}
}Also, see general guidelines for implementing secure authentication services here.
Authentication consists of calling the Validate() method of the authentication token validator. The internal implementation of the validation process is described in more detail below and in the Web eID system architecture document.
When using standard ASP.NET cookie authentication,
- create the Authentication Middleware services with
AddAuthenticationandAddCookiemethods in theStartup.ConfigureServicesmethod:services .AddAuthentication(CookieAuthenticationDefaults.AuthenticationScheme) .AddCookie();
- in
Startup.Configure, callUseAuthenticationandUseAuthorizationto set theHttpContext.Userproperty and run Authorization Middleware for requests. Call theUseAuthenticationandUseAuthorizationmethods before callingUseEndpoints:app.UseAuthentication(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); endpoints.MapRazorPages(); });
- create a REST endpoint that deals with authentication and creates an authentication cookie:
using System; using System.Collections.Generic; using System.Security.Claims; using System.Text.Json.Serialization; using System.Threading.Tasks; using Microsoft.AspNetCore.Authentication; using Microsoft.AspNetCore.Authentication.Cookies; using Microsoft.AspNetCore.Mvc; using WebEid.Security.Util; using WebEid.Security.Validator; [Route("[controller]")] [ApiController] public class AuthController : ControllerBase { private readonly IAuthTokenValidator authTokenValidator; public AuthController(IAuthTokenValidator authTokenValidator, IChallengeNonceStore challengeNonceStore) { this.authTokenValidator = authTokenValidator; this.challengeNonceStore = challengeNonceStore; } [HttpPost] [ValidateAntiForgeryToken] [Route("login")] public async Task Login([FromBody] AuthenticateRequestDto authToken) { var certificate = await this.authTokenValidator.Validate(authToken.AuthToken, this.challengeNonceStore.GetAndRemove().Base64EncodedNonce); var claims = new List<Claim> { new Claim(ClaimTypes.GivenName, certificate.GetSubjectGivenName()), new Claim(ClaimTypes.Surname, certificate.GetSubjectSurname()), new Claim(ClaimTypes.NameIdentifier, certificate.GetSubjectIdCode()) }; var claimsIdentity = new ClaimsIdentity(claims, CookieAuthenticationDefaults.AuthenticationScheme); var authProperties = new AuthenticationProperties { AllowRefresh = true }; await HttpContext.SignInAsync( CookieAuthenticationDefaults.AuthenticationScheme, new ClaimsPrincipal(claimsIdentity), authProperties); } [HttpGet] [ValidateAntiForgeryToken] [Route("logout")] public async Task Logout() { await HttpContext.SignOutAsync( CookieAuthenticationDefaults.AuthenticationScheme); } }
The Web eID authentication token validation library for .NET contains the implementation of the Web eID authentication token validation process in its entirety to ensure that the authentication token sent by the Web eID browser extension contains valid, consistent data that has not been modified by a third party. It also implements secure challenge nonce generation as required by the Web eID authentication protocol. It is easy to configure and integrate into your authentication service.
The authentication protocol, validation requirements, authentication token format and nonce usage are described in more detail in the Web eID system architecture document.
The authentication token validation process consists of two stages:
- First, user certificate validation: the validator parses the token and extracts the user certificate from the unverifiedCertificate field. Then it checks the certificate expiration, purpose and policies. Next it checks that the certificate is signed by a trusted CA and checks the certificate status with OCSP.
- Second, token signature validation: the validator validates that the token signature was created using the provided user certificate by reconstructing the signed data
hash(origin)+hash(challenge)and using the public key from the certificate to verify the signature in thesignaturefield. If the signature verification succeeds, then the origin and challenge nonce have been implicitly and correctly verified without the need to implement any additional security checks.
The website back end must lookup the challenge nonce from its local store using an identifier specific to the browser session, to guarantee that the authentication token was received from the same browser to which the corresponding challenge nonce was issued. The website back end must guarantee that the challenge nonce lifetime is limited and that its expiration is checked, and that it can be used only once by removing it from the store during validation.
As described in section 5. Configure the authentication token validator, the mandatory configuration parameters are the website origin and trusted certificate authorities.
Origin must be the URL serving the web application. Origin URL must be in the form of "https://" <hostname> [ ":" <port> ] as defined in MDN and not contain path or query components. Note that the origin URL must not end with a slash /.
The trusted certificate authority certificates are used to validate that the user certificate from the authentication token is signed by a trusted certificate authority. Intermediate CA certificates must be used instead of the root CA certificates so that revoked CA certificates can be detected. Trusted certificate authority certificates configuration is described in more detail in section 4. Add trusted certificate authority certificates.
Before validation, the previously issued challenge nonce must be looked up from the store using an identifier specific to the browser session. The challenge nonce must be passed to the validate() method in the corresponding parameter. Setting up the challenge nonce store is described in more detail in section 2. Configure the challenge nonce store.
The authentication token validator configuration and construction is described in more detail in section 5. Configure the authentication token validator. Once the validator object has been constructed, it can be used for validating authentication tokens as follows:
string challengeNonce = challengeNonceStore.GetAndRemove().Base64EncodedNonce;
WebEidAuthToken token = tokenValidator.Parse(tokenString);
X509Certificate2 userCertificate = tokenValidator.Validate(token, challengeNonce);The Validate() method returns the validated user certificate object if validation is successful or throws an exception as described in section Possible validation errors below if validation fails. The X509CertificateExtensions class contains extension methods for extracting user information from the user certificate object:
using WebEid.Security.Util;
...
userCertificate.GetSubjectCn(); // "JÕEORG\\,JAAK-KRISTJAN\\,38001085718"
userCertificate.GetSubjectIdCode(); // "PNOEE-38001085718"
userCertificate.GetSubjectCountryCode(); // "EE"The following additional configuration options are available in AuthTokenValidatorBuilder:
WithoutUserCertificateRevocationCheckWithOcsp()– turns off user certificate revocation check with OCSP. OCSP check is enabled by default and the OCSP responder access location URL is extracted from the user certificate AIA extension unless a designated OCSP service is activated.WithDesignatedOcspServiceConfiguration(DesignatedOcspServiceConfiguration serviceConfiguration)– activates the provided designated OCSP responder service configuration for user certificate revocation check with OCSP. The designated service is only used for checking the status of the certificates whose issuers are supported by the service, for other certificates the default AIA extension service access location will be used. See configuration examples in tests.WithOcspRequestTimeout(TimeSpan ocspRequestTimeout)– sets both the connection and response timeout of user certificate revocation check OCSP requests. Default is 5 seconds.WithDisallowedCertificatePolicies(params string[] policies)– adds the given policies to the list of disallowed user certificate policies. In order for the user certificate to be considered valid, it must not contain any policies present in this list. Contains the Estonian Mobile-ID policies by default as it must not be possible to authenticate with a Mobile-ID certificate when an eID smart card is expected.WithNonceDisabledOcspUrls(params Uri[] urls)– adds the given URLs to the list of OCSP URLs for which the nonce protocol extension will be disabled. Some OCSP services don't support the nonce extension. Contains the ESTEID-2015 OCSP URL by default.
Extended configuration example:
AuthTokenValidator validator = new AuthTokenValidatorBuilder(logger)
.WithSiteOrigin("https://example.org")
.WithTrustedCertificateAuthorities(TrustedCertificateAuthorities)
.WithoutUserCertificateRevocationCheckWithOcsp()
.WithDisallowedCertificatePolicies("1.2.3")
.WithNonceDisabledOcspUrls(new Uri("http://aia.example.org/cert"))
.Build();Unless a designated OCSP responder service is in use, it is required that the AIA extension that contains the certificate’s OCSP responder access location is present in the user certificate. The AIA OCSP URL will be used to check the certificate revocation status with OCSP.
Note that there may be limitations to using AIA URLs as the services behind these URLs provide different security and SLA guarantees than dedicated OCSP responder services. In case you need a SLA guarantee, use a designated OCSP responder service.
Authentication token validation internal logging uses Microsoft.Extensions.Logging. It is recommended that you provide an ILogger instance to the constructor of AuthTokenValidatorBuilder.
var loggerFactory = LoggerFactory.Create(builder =>
{
builder.AddConsole();
});
var logger = loggerFactory.CreateLogger("Logger name");
AuthTokenValidator validator = new AuthTokenValidatorBuilder(logger)
...
.Build();The Validate() method of AuthTokenValidator returns the validated user certificate object if validation is successful or throws an exception if validation fails. All exceptions that can occur during validation derive from AuthTokenException, the list of available exceptions is available here. Each exception file contains a documentation comment under which conditions the exception is thrown.
In the code examples above we use the classical stateful ASP.NET session cookie-based authentication mechanism, where a cookie that contains the user session ID is set during successful login and session data is stored at sever side. Cookie-based authentication must be protected against cross-site request forgery (CSRF) attacks and extra measures must be taken to secure the cookies by serving them only over HTTPS and setting the HttpOnly, Secure and SameSite attributes.
A common alternative to stateful authentication is stateless authentication with JSON Web Tokens (JWT) or secure cookie sessions where the session data resides at the client side browser and is either signed or encrypted. Secure cookie sessions are described in RFC 6896 and in the following article about secure cookie-based Spring Security sessions. Usage of both an anonymous session and a cache is required to store the challenge nonce and the time it was issued before the user is authenticated. The anonymous session must be used for protection against forged login attacks by guaranteeing that the authentication token is received from the same browser to which the corresponding challenge nonce was issued. The cache must be used for protection against replay attacks by guaranteeing that each authentication token can be used exactly once.
The authentication protocol requires support for generating challenge nonces, large random numbers that can be used only once, and storing them for later use during token validation. The validation library uses the System.Security.Cryptography.RandomNumberGenerator API as the secure random source and provides WebEid.Security.Cache.ICache interface for storing issued challenge nonces.
The authentication protocol requires a REST endpoint that issues challenge nonces as described in section 6. Add a REST endpoint for issuing challenge nonces.
Nonce usage is described in more detail in the Web eID system architecture document.
As described in section 3. Configure the nonce generator, the only mandatory configuration parameter of the challenge nonce generator is the challenge nonce store.
The challenge nonce store is used to save the nonce value along with the nonce expiry time. It must be possible to look up the challenge nonce data structure from the store using an identifier specific to the browser session. The values from the store are used by the token validator as described in the section Authentication token validation > Basic usage that also contains recommendations for store usage and configuration.
The nonce generator configuration and construction is described in more detail in section 3. Configure the nonce generator. Once the generator object has been constructed, it can be used for generating nonces as follows:
ChallengeNonce challengeNonce = nonceGenerator.GenerateAndStoreNonce(timeToLive); The GenerateAndStoreNonce(TimeSpan ttl) method both generates the nonce and stores it in the store. The ttl parameter defines nonce time-to-live duration. When the time-to-live passes, the nonce is considered to be expired.