This page:

Related pages:

• Authentication Service
• Signature Service
• Organisation ID Service
• Integrator Relying Party Management
• Custom Identifier Management
• Implementation - Troubleshooting and Best Practices

Thank you for subscribing to Freja eID services.

Freja eID is an electronic identification (eID) solution for citizens and organisations which can be used for authentication and signing. The essential part of Freja eID service is a smartphone application used for login and signing to all the services that are connected to the user´s eID. The second part is a web portal – My Pages – where the user can control how their eID is to be used and has a full record of user history.

In terms of Relying Parties (RPs), Freja eID offers great flexibility in terms of addressing end users. For example, the identity assurance level of end users registered with Freja eID can vary. If the user has followed an entry-level registration flow, their identity will be assured to LOA1, also known as Freja eID Basic. At this level a user will have confirmed an email address, perfectly enough to allow, for example, login authentication in situations where an absolute identity is not of significance for the Relying Party - knowing that the end user accessing a Relying Party's service is the same one that accessed the service a week ago without the hassle of teaching the end user an additional password is perfectly enough for many web-based services.

However, end users may opt for an extended registration process in order for their identity to be assured to LOA2 or LOA3: if the end user opted for an extended registration process,

• For LOA2, users need to undergo a verification process with their ID document within the Freja eID app, as well as face enrollment;
• For LOA3, also known as Freja eID Plus, users need to do an in-person identity check, whereby their real-life identity is connected to their digital identity. The assurance here being the physical ID document that was verified for LOA2.

These users (both those verified for LOA2 and LOA3) can then be referred to through their social security number (SSN). In Sweden, this would equate to having established a "personnummer" for the end user. Also, these users can be involved in interactions with web parties that involve login, but also legally binding signatures.

For easier integration, Freja eID also makes a distinction between Relying Parties, depending on the way they can integrate with us:

• Stand-alone Relying Party - a Relying Party that wants to integrate with us on their own behalf;
• Integrator Relying Party - a Relying Party that usually acts on behalf of their own customers, i.e. other organisations with their own branding, but can also integrate with us on their own behalf;
• Integrated Relying Party - a Relying Party which is not connected with Freja eID system directly, rather via the Integrator Relying Party.

Read more about how Integrator and Integrated Relying Parties can integrate with Freja eID in Integrator Relying Party Management.

This document contains instructions for enabling Relying Party applications to use services offered by Freja eID. It is of a technical nature - if you are not a software architect or developer, it is probably the wrong document to read.

Freja eID offers three services to Relying Parties: Authentication Service, Signing Service, and Organisation ID Service. Our recommendation is to read the sections of interest to you in their entirety at least once. On later occasions, use the links to quickly navigate to the section of interest.

Document Versions

Abbreviations

Getting started  

About Freja eID environments

The Freja eID system offers two environments:

• Test or Demo Environment, which is designed for testing purposes, it is intended to be used by Relying Parties during the process of integration with Freja eiD to test the integrated services.
• Production Environment, which is where the Freja eID services are actually available for business use and where the real-time staging of integrated services is executed.

Note that the Test Environment resembles the Production Environment as much as is possible in all segments.

Before you begin

Test environment checklist

There are several technical requirements that must be in place before the integration with Freja eID can start. Before proceeding, you need to:

• Obtain an SSL/TLS client certificate providing you access to the Freja eID Test Environment. For more information, refer to the Certificates section.
• Import Freja eID Test root certificate as trusted in the trust store of your application.
• Using Freja eID mobile application, register one or more users with the Freja eID Test infrastructure.

Production environment checklist

In order to use Freja eID in a Production Environment, you must fulfil the following:

• Sign a contract allowing your organisation to access the production Freja eID Authentication service.
• Provide Freja eID with a logo suitable to represent your organisation in the mobile application, as well as a display name, a URL and a short description. Please note that:
  
  • The logo must be delivered in one of the vector file formats: AI (Adobe Illustrator Artwork), EPS (Encapsulated PostScript) or editable PDF (Portable Document Format). The preferable format is AI (filename extension is .ai).  
  • The display name is restricted to the maximum length of 100 characters and the description should not exceed 500 characters. The URL can be up to 100 characters long.
    
• Obtain an SSL/TLS client certificate providing you access to the Freja eID Production Environment. For more information, refer to the Certificates section.
• Import Freja eID Production root certificate as trusted in the trust store of your application.

Certificates in Freja eID

Freja eID system requires the usage of SSL/TLS certificates for communication with Relying Party applications. The following certificates are used:

• Freja eID's server certificate:
  • Freja eID Test root certificate
  • Freja eID Production root certificate
• Relying Party's client certificate:
  • Test client certificate
  • Production client certificate
    

Additionally, JWS certificates are used to digitally sign the results of authentication and signature requests.

Server SSL certificate

Freja eID Server certificate is used so that Relying Parties can authenticate Freja eID as trusted in their environment. Freja eID's Server certificate should be imported in the trust store of the Relying Party's application. There are two server certificates which you need to use:

• Freja eID Test root certificate, when you want to start the integration in the Test Environment
• Freja eID Production root certificate, when you want to execute your integration in the Production Environment

Below are Freja eID's Test and Production root certificates, PEM encoded:

Client SSL certificate

As mentioned before, to access and use Freja eID services, you need to obtain a client SSL/TLS certificate. Two client certificates are needed, one for access to the Testing Environment and one for access to the Production Environment. Client certificate authenticates your application when it tries to communicate with Freja eID services. Additionally, Freja eID uses your Client certificate to identify you in its system when you try to send an authentication or signing request.

The following section provides you with instructions on how to generate an SSL/TLS key and a certificate signing request (CSR), which you can then send to Freja eID partner support to provide you with the ready-made client certificate. It also documents how to create a PKCS#12 file.

What is an SSL/TLS key and what is it used for?

The SSL/TLS key is a part of the Public Key Infrastructure (PKI) that is generally used in case of SSL/TLS certificates. A Public Key Infrastructure assumes asymmetric encryption, where two types of keys are used: a Private Key and a Public Key (included in an SSL/TLS certificate). The private key is based on the RSA algorithm and is used for authentication and the establishment of an SSL/TLS session. Since encrypted data transmission takes too much time in case of asymmetric encryption, this kind of encryption is only used for a secure exchange of the symmetric key, which is used for actual transmitted data encryption and decryption. 

What is a certificate signing request (CSR)?

A certificate signing request (also CSR or certification request) is a block of encoded text that is given to a certificate authority (CA) when applying for an SSL/TLS certificate. It is usually generated on the server where the certificate will be installed on and contains information that will be included in the certificate, such as the organisation name, common name (domain name), locality and country. It also contains the public key that will be included in the certificate. The private key is usually created at the same time as the CSR, thus making a key pair. A CSR is generally encoded using ASN.1, according to the PKCS #10 specification.

Distinguished name

SSL/TLS certificates contain identifying information, such as the qualified domain name used for DNS lookups of your server (also called Common Name), your organisation or company name and location information. This information is called the certificate's Distinguished Name. When generating a CSR on your server, you are asked to enter the Distinguished Name, which uniquely identifies your server.

This is an example list of required fields for the Subject's Distinguished Name used when generating a CSR request for a Freja eID Relying Party named "ACME AB":

Client certificate generation - Step-by-step guide

1. Launch Open SSL (preferably on the production server) and generate your private key with the genrsa command (see below). Command arguments are the location and file name where you wish to store your key and the key strength (with the minimum value of 2048 bits). You will also be prompted to choose a secure passphrase for the key.

   openssl genrsa -F4 -aes256 -out <PATH_TO_YOUR_PRIVATE_KEY>.key 2048

   Security recommendations

   As the security relies on the integrity and security of this private key, it is the best practice to generate the key on the production system itself and also to make sure that this key is protected duly against unauthorised attacks by limiting access to the key file itself. Once the PKCS#12 file has been generated, the key file can be removed or stored securely offline for backup purposes.

2. Next, generate the CSR using the key generated in step 1 with the following command and put it in a file.

   openssl req -new -subj "/C=SE/2.5.4.97=556677-8888/OU=Production/O=ACME AB/CN=Document signing service" -key <PATH_TO_YOUR_PRIVATE_KEY>.key -out <PATH_TO_YOUR_CSR>.csr

3. Compress the file with ZIP/gZIP and email it to partnersupport@frejaeid.com. After the certificate is issued by the Freja eID Support, you will receive a ZIP file with your new certificate, along with required Freja eID CA certificates.

   Filename	Description	Distinguished Name	Issuer
   Freja eID Production Root.cer	Freja eID's offline root certificate	CN = Freja eID Root CA v1 OU = Production O = Verisec Freja eID AB 2.5.4.97 = 559110-4806 C = SE	CN = Freja eID Root CA v1 OU = Production O = Verisec Freja eID AB 2.5.4.97 = 559110-4806 C = SE
   Freja eID Production Issuing CA.cer	Freja eID's Issuing Certificate Authority	CN = Freja eID Issuing CA v1 OU = Production O = Verisec Freja eID AB 2.5.4.97 = 559110-4806 C = SE	CN = Freja eID Root CA v1 OU = Production O = Verisec Freja eID AB 2.5.4.97 = 559110-4806 C = SE
   Freja eID Production Certificates.pem	Freja eID certificate chain. Contains booth root and CA certificates
   <YOUR CERTIFICATE>.cer	Your relying party issued certificate	CN = Document signing service OU = Production O = ACME AB 2.5.4.97 = 556677-8888 C = SE	CN = Freja eID Issuing CA v1 OU = Production O = Verisec Freja eID AB 2.5.4.97 = 559110-4806 C = SE

4. Generate the PKCS#12 keystore file with the following command and choose a secure passphrase:

   openssl pkcs12 -aes256 -CAfile "Freja eID Production Certificates.pem" -export -in <YOUR CERTIFICATE>.cer -inkey <YOUR_PRIVATE_KEY>.key -out <YOUR_KEYSTORE>.pfx

   Security recommendations

   As the security relies on the integrity and security of this keystore, create it on the production system and protect it the production system itself and also make sure that this key is protected duly against unauthorised attacks by limiting access to the keystore file itself.

5. Verify connectivity against production with the following command:

   openssl s_client -verify_return_error -CAfile "Freja eID Production Certificates.pem" -cert <YOUR CERTIFICATE>.cer -key <YOUR_PRIVATE_KEY>.key -connect services.prod.frejaeid.com:443

   Reminder

   Once connectivity has been verified, files from the ZIP file should be deleted to avoid misunderstandings.

   
   

Authentication and Signature services are exposed through a RESTful API. This section presents information common to both services. Firstly, the following applies to HTTP response codes.

{
   "code": "Integer with error code value",
   "message": "Error description"
}