ENTERPRISE  This is an EJBCA Enterprise feature.

The following covers information on the EJBCA REST Interface for Certificate Management and CA Administration operations.

API Overview

EJBCA Certificate Management REST API contains endpoints intended for integration with EJBCA, using CA Management, Crypto token management, Certificate management and ConfigDump RESTful Web Services. This allows for easy integration and lightweight HTTP interaction for the most crucial parts of EJBCA.

The scope of the API is limited compared to the full set of features provided by EJBCA and provides functionality such as certificate requests, enrollment, revocation, import and exporti of ConfigDump configurations, and more. For a full description of the functionality provided, see Resources.

REST API Reference 

Each EJBCA release is bundled with an auto-generated REST API reference available on the URL https://localhost:8442/ejbca/doc/rest/ if deployed.

Swagger UI

Swagger UI allows you to visualize and interact with the API’s resources. The Swagger UI playground is available in your browser on the URL https://localhost:8443/ejbca/swagger-ui (use port 8443 since the REST API uses client certificate authentication).

The Swagger UI is only available if you build EJBCA in non-production mode, i.e. with ejbca.productionmode=false set in conf/ejbca.properties, and if REST is activated as a protocol (see below).

Getting Started

The EJBCA Certificate Management REST API is disabled by default. To enable the service, go to Administrator Web > System Configuration > Protocol Configuration and select Enable for the REST end point you want to use.

Integrating with the REST API and consuming the response can be done with any tool of choice. For basic GET requests, any web browser is sufficient and for improved integration, a REST library or similar tool is recommended.

The following shows an example of a basic request:

GET https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/status
CODE

Resulting in the following JSON response. Note that version and revision may vary.

{
	"status":"OK",
	"version":"1.0",
	"revision":"ALPHA"
}
CODE

You can access the URL above using for example cURL, your browser, or any other tool. Note that the REST API requires client certificate authentication, see Authentication.

Integrating with the REST API

Requests to the API are submitted using RESTful URLs with the standard HTTP methods: GET, POST, PUT. Additionally, some endpoints accept a JSON request body. Put together, each request consists of the HTTP method, endpoint URL, and (for some endpoints) a request body. Some endpoints require you to include an HTTP method header:

Content-Type: application/json
CODE

Generally, responses consist of an HTTP header including an RFC 2616 status code, and an application/json response body. For information on exceptions, see Responses.

In case of an error, the response body contains an appropriate error message describing the event.

 Resources 

The certificate management REST API provides four base resource URLs:

/ejbca/ejbca-rest-api/v1/ca_management/
/ejbca/ejbca-rest-api/v1/ca/
/ejbca/ejbca-rest-api/v1/certificate/
/ejbca/ejbca-rest-api/v1/configdump/ 
/ejbca/ejbca-rest-api/v1/cryptotoken/
/ejbca/ejbca-rest-api/v1/endentity/
/ejbca/ejbca-rest-api/v2/certificate/
CODE

Each resource provides endpoints of interaction.

Endpoints under the /ca_management/ resource allow manipulating CAs, for example activating and deactivating a CA.

The /ca/ resource allows retrieving CA certificates, CRLs, and so on.

The /certificate/ resource handles certificate enrollment, revocation and other workflows related to managing certificates.

The /configdump/ resource handles import and export of configurations (publishers, certification authorities, roles etc) via the ConfigDump tool.

The /cryptotoken/ resource handles crypto token activation, deactivation, and crypto token key generation.

The /endentity/ resource handles adding, editing and deleting end entities.

For a full set of all endpoints, required input, responses, and other endpoint descriptions, see REST API Reference or try it out in the Swagger UI.

Requests

Each endpoint URL is built in the same way by the following structure:

https://[DOMAIN_NAME]:[PORT]/ejbca/ejbca-rest-api/[API_VERSION]/[RESOURCE]/[IDENTIFIER]/[OPERATION]?[QUERY_PARAM]
CODE

Explanation

  • DOMAIN_NAME: Domain name of the EJBCA instance, for example: localhost.
  • PORT: Secure port of the EJBCA instance, for example: 8443.
  • API_VERSION: Version of the REST API, for example: v1.
  • RESOURCE: One of the two base resources /ca/ or /certificate/.
  • IDENTIFIER: Identifier of the entity to perform the operation on. This might be a Subject DN, serial number, or both combined. A composite identifier could look like .../{issuer_dn}/{certificate_serial_number_hex}/revocationstatus.
  • OPERATION: The operation to perform, for example: /revocationstatus.
  • QUERY_PARAM: HTTP query parameters. Some endpoints accept query parameters rather than a JSON body. For example .../revoke?reason=KEY_COMPROMISE.

Note that not all endpoints require the identifier or query parameters. For example, the following is not specific for an entity and does not accept an identifier:

GET https://localhost:8443/ejbca/ejbca-rest-api/v1/ca/status
CODE

Methods

Each request requires a specified HTTP method. The expected method for each endpoint can be seen in REST API Reference or the Swagger UI.

In general, the method used corresponds to the expected state change performed.

MethodDescriptionExample
GETUsed only to read data and not change it..../{issuer_dn}/{certificate_serial_number_hex}/revocationstatus
PUTUsed in operations that updates some entity state..../{issuer_dn}/{certificate_serial_number_hex}/revoke
POSTUsed in operations which creates some entity..../enrollkeystore
DELETEUsed in operations which deletes some entity.../endentity{endentity_name}

Request Body

As mentioned, some endpoints accept a request body containing the desired input data. Request bodies must only contain JSON formatted data and the header Content-Type: application/json must be set in the request for the request to be accepted. All input fields (not values) must be snake_case formatted, e.g. "key_alg" rather than "keyAlg" or "key alg".

The following example shows a request to enroll a keystore (using cURL):

curl -X POST -H 'Content-Type: application/json' -i 'https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/enrollkeystore' --data '{
"username":"testUser",
"password":"foo123",
"key_alg":"RSA",
"key_spec":"2048"
}'
CODE

 Responses 

While integrating with the REST API, the most relevant information in the response is the status-line (HTTP status code), Content-Type header, and the response body.

Status Codes

Any response code within the range of 2xx - 3xx may be considered successful. This means that the server has accepted the request and sent an appropriate response. The typical response code from a GET request would be 200 - OK. When the operation requires an approval by another administrator, the response will be 201 - Accepted, meaning that the request has been accepted successfully and is awaiting approval.

Response codes in the range 4xx - 5xx should be considered errors. It may be an authentication failure, conflict or a general server error. For example, requesting an operation not allowed using your specific client certificate will generate 403 - Unauthorized, most likely followed by some response message in the response body.

For a complete list of codes that may occur while interacting with the API, see Status Codes.

Response Body

The content type of the response can be determined by the Content-Type header and most endpoints will always return application/json. Exceptions include for example calling .../ca/{issuer_dn}/certificate/download which returns a byte streamed .pem certificate. In this case, the wildcard header */* is used. All requests regardless of response code, which reach the server will retrieve a response body. Any response to a successful request will contain a body including the requested information, for example:

curl -X GET -i 'https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/CN%3DManagementCA%2CO%3DEJBCA%20Sample%2CC%3DSE/4b0b0ceb7a8e5f1f/revocationstatus'
CODE

Returns the following JSON body (given that the certificate is found):

{
  "issuer_dn": "CN=ManagementCA,O=EJBCA Sample,C=SE",
  "serial_number": "4b0b0ceb7a8e5f1f",
  "revocation_reason": "KEY_COMPROMISE",
  "revocation_date": "2018-06-27T08:07:52Z",
  "revoked": true
}
CODE

In the event of an error, a response body containing the status code (in addition to the header), and an appropriate error message are returned.

For example, if the request above was done for a CA which does not exist, the client could expect a response like: 

{
  "error_code": 404,
  "error_message": "CA 'CN=NonExistingCA,O=EJBCA Sample,C=SE' does not exist."
}
CODE

If a completely unexpected error occurs, the server will respond with 500 - General failure. If this occurs, verify the content of the request and next require that the CA Administrator checks the server log.

Authentication 

The REST API requires client certificate authentication from administrators just as the Admin GUI does. If you have a working Admin GUI client certificate, you should also be able to use it for the REST API. How the certificate is passed with the request depends on your integration environment. To verify server response and authentication, attempt accessing the API through any web browser using your client certificate:

https://[DOMAIN_NAME]:[PORT]/ejbca/ejbca-rest-api/v1/ca/version
CODE

You can also use cURL or a similar tool by specifying --cert and --key.

If no certificate or an invalid certificate is provided, you'll most likely be presented with a "Bad certificate" error. However, if an attempt is made to request a resource above the privileges of a valid certificate, the response will contain a JSON formatted response body with the status code 403 - Unauthorized followed by an appropriate response message. For more information, see Status Codes.

Debugging REST API

By default, EJBCA logs basic information about incoming requests and INFO level.

The following info is logged in INFO logging level:

  • remote address
  • "X-Forwarded-For" header value

Example:

13:31:07,976 INFO [org.ejbca.ui.web.rest.api.config.RestLoggingFilter] (default task-10) GET https://localhost:8443/ejbca/ejbca-rest-api/v1/ca/CN=Management%20CA,O=PK,C=SE/certificate/download received from 127.0.0.1 X-Forwarded-For: null
CODE

It is also possible to make EJBCA log the complete requests and responses at TRACE level.

The following info is logged in TRACE level:

  • request and response
  • time taken per request, i.e. endtime - starttime

As enabling TRACE logging globally, for all of EJBCA, may result in excessive logging, it is possible to enable it for the RestLoggingFilter only. On JBoss/WildFly this is done with simple commands in the jboss-cli:

/subsystem=logging/logger=org.ejbca.ui.web.rest.api.config:add
/subsystem=logging/logger=org.ejbca.ui.web.rest.api.config:write-attribute(name=level, value=TRACE) 
CODE

Example TRACE logging for a simple request is:

curl -X GET "https://localhost:8443/ejbca/ejbca-rest-api/v1/ca/CN=Management%20CA,O=PK,C=SE/certificate/download" --insecure --cert cert-superadmin.pem --key key-superadmin.pem
CODE
2018-08-07 13:31:08,038 TRACE [org.ejbca.ui.web.rest.api.config.RestLoggingFilter] (default task-10) GET https://localhost:8443/ejbca/ejbca-rest-api/v1/ca/CN=Management%20CA,O=PK,C=SE/certificate/download received from 127.0.0.1 X-Forwarded-For: null
Request headers:
  Accept: */*
  User-Agent: curl/7.47.0
  Host: localhost:8443
Request data:
  
Response data:
Subject: CN=Management CA,O=PK,C=SE
Issuer: CN=Management CA,O=PK,C=SE
-----BEGIN CERTIFICATE-----
MIIDTzCCAjegAwIBAgIIbbifeqpPKLcwDQYJKoZIhvcNAQELBQAwNTEWMBQGA1UE
<snip>
xdd9ycYOyym2nvM+SPydHlK8dAqwwXzICFFOCRADsQNakVU=
-----END CERTIFICATE-----

Time taken: 62ms
CODE

Status Codes

API status codes are exposed in standard HTTP response codes and JSON formatted messages. For example, the following example shows an HTTP 403 error:

{
  "error_code": 403,
  "error_message": "Not authorized to resource /administrator."
}
CODE

The response code will also be available in the HTTP response status line. The following table describes status codes that may be "expected" responses from the REST API and a few possible reasons.

HTTP Status CodeGeneral DescriptionEJBCA REST API Context
200OKSuccessful HTTP request, expect a proper response body. Typically received from a successful GET request.
201CreatedSuccessful HTTP request. Some entity has been created, e.g. certificate enrolled. Typically received after a successful POST request.
202AcceptedRequest accepted by the server but awaiting processing. Most likely waiting for administrator approval.
400Bad RequestA common error that can be caused by many conditions such as:
  • invalid input parameters / JSON body in the request
  • an invalid alias in the request path
  • the requested CA does not exists
  • error creating or renewing a certificate due to pre-conditions not being fulfilled by the request
    (this can be many things like trying to renew with the same public key when it's not allowed, etc, etc)

Hints on what caused the issue is typically returned in the message part of the HTTP error response and are logged in the server log file for administrators.

403ForbiddenRequest accepted but the operation is refused due to insufficient privileges, disabled features etc.
404Not FoundRequested entity was not found by EJBCA. Could occur if the input refers to a non-existing entity, such as a user or a CA.
409ConflictConflict occurred while processing request, e.g. trying to revoke an already revoked certificate.
413Payload Too LargeThe request is larger than the server is willing to process. Should not occur while using the API as intended.
422Unprocessable EntityWell-formed request but unable to process due to e.g. semantic errors. Could occur in case of invalid key algorithm, validity etc.
500Internal Server ErrorUnexpected error while calling the API. For additional details, refer to the server log (CA Administrator).
503Service UnavailablePossible reason could be that the CA is offline, CT log is unavailable etc.

API Version

 All EJBCA REST resources use URI versioning.

Example: https://hostname:8443/ejbca/ejbca-rest-api/v1/certificate/search in which v1 defines the API version.

The API version will not change with new versions of EJBCA unless:

  • Any required endpoint parameter has changed.
  • The response format of any endpoint has changed.

Generally, such changes to existing endpoints will be avoided since they would break existing client integrations. If such a change is made, it will be in a major EJBCA release and clearly documented in the EJBCA Upgrade Notes.

However, the API continuously evolves with new endpoints. New endpoints do not affect the API version, nor if additional fields are added to an existing response (within the same response format).

Examples

Generate a CSR and Request a Certificate using Bash

You can use OpenSSL, jq, and cURL (version >7.57) to create a key and a CSR, create a JSON payload containing the CSR, and then enroll for a TLS server certificate using the configuration file and script below.

Configuration File Example

csr.conf

[req]
distinguished_name = req_distinguished_name
req_extensions = v3_req
prompt = no


[req_distinguished_name]
C = SE
O = PrimeKey Solutions AB
OU = Infra
CN = primekey.com

[v3_req]
keyUsage = keyEncipherment, digitalSignature
extendedKeyUsage = serverAuth
subjectAltName = @alt_names

[alt_names]
DNS.1 = primekey.com
CODE

Script Example

The pkcs10enroll.sh script generates a new CSR if one does not already exist, requests a certificate from EJBCA, and then prints the JSON response to stdout.

To enable usage of self-signed certificates in development, add -k to the curl options. To view the error message from curl, remove -s.

pkcs10enroll.sh

#!/bin/sh

# Before running this script you need to do the following:

# 1. If you are contacting the CA directly:
#
#     Enable the REST API in System Configuration -> Protocol Configuration.
#
#     If you are contacting an external RA, you should enable the REST API for
#     the peer role on the CA.

hostname="172.16.31.14"

# 2. Specify profiles, CA and end entity to use for issuance

cert_profile_name="staging-cert"
ee_profile_name="staging-ee"
ca_name="Issuing CA"
# This user will be created if it does not exist. The status of an existing
# end entity will be set to NEW automatically.
username="pkcs10enroll_user"
# If the user already exists, specify the enrollment code here
enrollment_code="foo123"

# 3. Adjust the variable $client_cert to point to a client certificate.

client_cert="/opt/jboss/p12/SuperAdmin.p12:foo123"

if [ ! -f 'server.csr' ]; then
    openssl req -new -out server.csr -newkey rsa:2048 \
	    -nodes -sha256 -keyout server.key \
	    -config csr.conf > /dev/null 2>&1
fi
csr=$(cat server.csr)
template='{"certificate_request":$csr, "certificate_profile_name":$cp, "end_entity_profile_name":$eep, "certificate_authority_name":$ca, "username":$ee, "password":$pwd}'
json_payload=$(jq -n \
    --arg csr "$csr" \
    --arg cp "$cert_profile_name" \
    --arg eep "$ee_profile_name" \
    --arg ca "$ca_name" \
    --arg ee "$username" \
    --arg pwd "$enrollment_code" \
    "$template")
curl -X POST -s \
    --cert-type P12 \
    --cert "$client_cert" \
    -H 'Content-Type: application/json' \
    --data "$json_payload" \
    "https://$hostname/ejbca/ejbca-rest-api/v1/certificate/pkcs10enroll" \
    | jq .
BASH

A JSON request (to be used in swagger-ui for example) would look like this, a plain PKCS#10 CSR using \n as line breaks:

{
"certificate_request":"-----BEGIN CERTIFICATE REQUEST-----\nMIIChTCCAW0CAQAwQDELMAkGA1UEBhMCU0UxDjAMBgNVBAgMBVNvbG5hMREwDwYD\nVQQKDAhQcmltZUtleTEOMAwGA1UEAwwFVG9tYXMwggEiMA0GCSqGSIb3DQEBAQUA\nA4IBDwAwggEKAoIBAQDfOpmUDnUsilYoaYpHUGN9AvAkK2AdHoYz4cTkKD4kPPvq\nErRdayyGWiuKrmhH6v+jPvh5ZYQoqL2viSTIkcvr7BIo9pgqSVswxvC5v4GGy3R4\nnme0El27oB5X0AJl3X5STT5GwIWw66XHcTeg1ux62bfY/N1RhiHanFOZ00DokPyW\n/s+dGcnZ9kBC5s5jcEEEwcGXCyKuyCoy60Z87asOraCsYeRlq3qqdms0BZEM7lLK\n7oP4HjIpk9VSLYihGlFsbophw96gNGtYjorX//CYvuyckUpA9TLdfx8IoQSiKlsJ\nCDdMeDXnkqOZAmXj3xos3qm1VJV2J9AVggzQ1SUnAgMBAAGgADANBgkqhkiG9w0B\nAQsFAAOCAQEAGcK8aMvmdhsTeCv+D1R21Bjc5fb+dmrXcYdR4RI8roW4GZDqGdBU\n8bYDZfO0SnV0q6m23G6upVhtYpzOrVcDaiQ4iFvGQkz8pfErZ+qqwZhE6yvbc+2p\n0BVuIIePbgdAW17acxkOF4p0Z5TkNazdNwePyjW8dfUvarVX//AA48l66bUXu6IM\nX2LU/OY1hcLETlAqV2o1iDPRsOTnF2OpV8FdmpBhD7VUa78h8n3w3l+WdmaAhcy4\njItzjKHi5CEoJ3s15Yo4zuwZt2g+bmGGfBqGcSKkPAlsQ+A79DMwzJXLN/Cs/joY\ngwObGYEkQqkX1DGjDNzYyw+RtvdzJV8shQ==\n-----END CERTIFICATE REQUEST-----",
"certificate_profile_name":"Client",
"end_entity_profile_name":"User",
"certificate_authority_name":"ManagementCA",
"username":"myuser",
"password":"foo123",
"include_chain":true
}
TEXT

with the resulting curl command (using superadmin.p12 for RA authentication):

curl -k --cert-type P12 --cert p12/superadmin.p12:ejbca -X POST "https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/pkcs10enroll" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"certificate_request\":\"-----BEGIN CERTIFICATE REQUEST-----\nMIIChTCCAW0CAQAwQDELMAkGA1UEBhMCU0UxDjAMBgNVBAgMBVNvbG5hMREwDwYD\nVQQKDAhQcmltZUtleTEOMAwGA1UEAwwFVG9tYXMwggEiMA0GCSqGSIb3DQEBAQUA\nA4IBDwAwggEKAoIBAQDfOpmUDnUsilYoaYpHUGN9AvAkK2AdHoYz4cTkKD4kPPvq\nErRdayyGWiuKrmhH6v+jPvh5ZYQoqL2viSTIkcvr7BIo9pgqSVswxvC5v4GGy3R4\nnme0El27oB5X0AJl3X5STT5GwIWw66XHcTeg1ux62bfY/N1RhiHanFOZ00DokPyW\n/s+dGcnZ9kBC5s5jcEEEwcGXCyKuyCoy60Z87asOraCsYeRlq3qqdms0BZEM7lLK\n7oP4HjIpk9VSLYihGlFsbophw96gNGtYjorX//CYvuyckUpA9TLdfx8IoQSiKlsJ\nCDdMeDXnkqOZAmXj3xos3qm1VJV2J9AVggzQ1SUnAgMBAAGgADANBgkqhkiG9w0B\nAQsFAAOCAQEAGcK8aMvmdhsTeCv+D1R21Bjc5fb+dmrXcYdR4RI8roW4GZDqGdBU\n8bYDZfO0SnV0q6m23G6upVhtYpzOrVcDaiQ4iFvGQkz8pfErZ+qqwZhE6yvbc+2p\n0BVuIIePbgdAW17acxkOF4p0Z5TkNazdNwePyjW8dfUvarVX//AA48l66bUXu6IM\nX2LU/OY1hcLETlAqV2o1iDPRsOTnF2OpV8FdmpBhD7VUa78h8n3w3l+WdmaAhcy4\njItzjKHi5CEoJ3s15Yo4zuwZt2g+bmGGfBqGcSKkPAlsQ+A79DMwzJXLN/Cs/joY\ngwObGYEkQqkX1DGjDNzYyw+RtvdzJV8shQ==\n-----END CERTIFICATE REQUEST-----\",\"certificate_profile_name\":\"Client\",\"end_entity_profile_name\":\"User\",\"certificate_authority_name\":\"ManagementCA\",\"username\":\"myuser\",\"password\":\"foo123\",\"include_chain\":true}"
TEXT

Revocation Workflow Example

Follow the example below to first check the revocation status of a certificate and then revoke the certificate.

In this example, the certificate's DN is CN=CA1 and serial number (in HEX) is 5CB3D42686039768D973E5694BF205377AF6.

  1. To check the revocation status of the certificate, call the GET /v1/certificate/{issuer_dn}/{certificate_serial_number}/revocationstatus REST method:

    curl -X GET -s \
    --cert-type P12 \
    --cert "/opt/jboss/p12/SuperAdmin.p12:foo123" \
    -H "accept: application/json"
    "https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/CN%3DCA1/5CB3D42686039768D973E5694BF205377AF6/revocationstatus"
    CODE
  2. From the response below, you can confirm that the certificate is active.

    {
    	"issuer_dn": "CN=CA1",
    	"serial_number": "5CB3D42686039768D973E5694BF205377AF6",
    	"revocation_reason": "NOT_REVOKED",
    	"revoked": false
    }
    CODE
  3. To revoke the certificate, call the PUT /v1/certificate/{issuer_dn}/{certificate_serial_number}/revoke REST method:

    curl -X PUT -s \
    --cert-type P12 \
    --cert "/opt/jboss/p12/SuperAdmin.p12:foo123" \
    -H "accept: application/json"
    "https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/CN%3DCA1/5CB3D42686039768D973E5694BF205377AF6/revoke?reason=KEY_COMPROMISE"
    CODE
  4. Confirm from the response that the certificate has been successfully revoked:

    {
    	"issuer_dn": "CN=HT_REMOVAL_CA",
    	"serial_number": "5CB3D42686039768D973E5694BF205377AF6",
    	"revocation_reason": "KEY_COMPROMISE",
    	"revocation_date": "2019-05-27T15:02:56Z",
    	"message": "Successfully revoked",
    	"revoked": true
    }
    CODE

Request a PKCS#12 Keystore Using Python

To request a PKCS#12 keystore using Python, do the following:

  1. Install the module requests_pkcs12 using pip.

    pip3 install requests_pkcs12
    BASH
  2. Authenticate with the client certificate stored in superadmin.p12 and request a PKCS12 file for the end entity python.

    import json
    from requests_pkcs12 import post
    response = post('https://myca:8443/ejbca/ejbca-rest-api/v1/certificate/enrollkeystore',
        json={
            'username': 'python',
            'password': 'foo123',
            'key_alg': 'RSA',
            'key_spec': '2048'
        },
        headers={ 
            'content-type': 'application/json' 
        },
        pkcs12_filename='/srv/superadmin.p12', 
        pkcs12_password='foo123', 
        verify='/srv/truststore.pem')
    
    print(json.dumps(json.loads(response.content), indent=4, sort_keys=True))
    PY

Request a PKCS#12 Keystore Using Node.js

To request a PKCS#12 keystore using Node.js, do the following:

  1. Install the node.js module called node-fetch.

    npm install node-fetch
    CODE
  2. Create a script which looks something like this: 

    const fs = require('fs');
    const https = require('https');
    const fetch = require('node-fetch');
    
    // Load the keystore used to authenticate to the REST API
    const pfx = fs.readFileSync('RA_Administrator.p12');
    const passphrase = 'foo123';
    const agent = https.Agent({ pfx, passphrase });
    
    // Load the enrollment code for the end entity
    const enrollmentCode = 'foo123'
    
    // Name of the end entity
    const deviceName = 'Permobil Device 1'
    
    // Request renewal of the device certificate
    fetch('https://nautilus:8443/ejbca/ejbca-rest-api/v1/endentity/' + deviceName + '/setstatus', {
          agent: agent,
          method: 'post',
          body: JSON.stringify({
            "password": enrollmentCode,
            "token": "P12",
            "status": "NEW"
          }),
          headers: { 'Content-Type': 'application/json' },
      })
      .then(res => {
        if (res.status != 200) {
          console.log('Renewal failed with status code ' + res.status + '.')
        } else {
          console.log('Renewal succeeded! Requesting new device certificate from EJBCA...')
          fetch('https://nautilus:8443/ejbca/ejbca-rest-api/v1/certificate/enrollkeystore', {
            agent: agent,
            method: 'post',
            body: JSON.stringify({
              "username": deviceName,
              "password": enrollmentCode,
              "key_alg": "RSA",
              "key_spec": "2048"
            }),
            headers: { 'Content-Type': 'application/json' },
          })
          .then(res => res.json())
          .then(json => console.log(json))
          .catch(error => console.log(error)) 
        }
      })
      .catch(error => console.log(error)) 
    JS

Search for Certificates

To search for certificates with multiple search criteria, use the search method.

Example Search Requests

Example JSON search request

The following shows an example JSON search request to search for ACTIVE certificates for the superadmin user, limiting the search to return a maximum of 10 certificates:

{
  "max_number_of_results": 10,
  "criteria": [
    {
      "property": "QUERY",
      "value": "superadmin",
      "operation": "EQUAL"
    },
    {
      "property": "STATUS",
      "value": "CERT_ACTIVE",
      "operation": "EQUAL"
    }
  ]
}
CODE

To search for DN or altName fields, for example, looking for a maximum of 10 certificates issued to a user with a Common Name like 'Firstname Lastname', use the following:

{
  "max_number_of_results": 10,
  "criteria": [
    {
      "property": "QUERY",
      "value": "Firstname Lastname",
      "operation": "LIKE"
    },
    {
      "property": "STATUS",
      "value": "CERT_ACTIVE",
      "operation": "EQUAL"
    }
  ]
}
CODE

Search for Certificates Version 2

To search for certificates with multiple search criteria, pagination and sorting use the search method version 2.

Example Search Requests

Example JSON search request

The following shows an example JSON search request to search for ACTIVE certificates, returning the first page with page size of 1000, limiting the search to return a maximum of 1000 certificates, sorted by the last time updated:

{   
  "pagination": {
    "page_size": 1000,
    "current_page": 1
  },
  "sort": {
    "property": "UPDATE_TIME",
    "operation": "ASC"
  },   
  "criteria": [
    {
      "property": "STATUS",
      "value": "CERT_ACTIVE",
      "operation": "EQUAL"
    }
  ]
}
CODE

Each query must contain at least one criteria. pagination and sort are optional. If pagination is missing, the total number of certificates for the criteria given is returned. In this case sort is ignored if present in the request. page_size and current_page must be greater than 0. property of sort can be one of

  • USERNAME
  • ISSUER_DN
  • SUBJECT_DN
  • EXTERNAL_ACCOUNT_BINDING_ID
  • END_ENTITY_PROFILE
  • CERTIFICATE_PROFILE
  • STATUS
  • TAG
  • TYPE
  • UPDATE_TIME
  • ISSUED_DATE
  • EXPIRE_DATE or
  • REVOCATION_DATE
Example cURL Search Command

The following shows an example cURL command to search for ACTIVE certificates for the superadmin user, limiting the search to return a maximum of 10 certificates:

curl -X POST "https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/search" \
-H  "accept: application/json" -H  "Content-Type: application/json" \
-d "{  \"max_number_of_results\": 10,  \"criteria\": [    {      \"property\": \"QUERY\",      \"value\": \"tomastest1.primekey.com\",      \"operation\": \"EQUAL\"    },    {      \"property\": \"STATUS\",      \"value\": \"CERT_ACTIVE\",      \"operation\": \"EQUAL\"    }  ]}"
CODE

Add End Entity

To add an end entity using the endentity endpoint, a JSON like this can be used:

{
  "username": "tomas44",
  "password": "foo123",
  "subject_dn": "CN=tomas44",
  "subject_alt_name": "",
  "email": "",
  "extension_data": [
    {
      "name": "foo",
      "value": "bar"
    }
  ],
  "ca_name": "ManagementCA",
  "certificate_profile_name": "Client",
  "end_entity_profile_name": "User",
  "token": "P12"
}
TEXT

and cURL:

curl -X POST "https://localhost:8443/ejbca/ejbca-rest-api/v1/endentity" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{  \"username\": \"tomas44\",  \"password\": \"foo123\",  \"subject_dn\": \"CN=tomas44\",  \"subject_alt_name\": \"\",  \"email\": \"\",  \"extension_data\": [    {      \"name\": \"foo\",      \"value\": \"bar\"    }  ],  \"ca_name\": \"ManagementCA\",  \"certificate_profile_name\": \"Client\",  \"end_entity_profile_name\": \"User\",  \"token\": \"P12\"}"
TEXT

After adding an end entity like that, you can enroll for a PKCS#12 keystore with the certificate/enrollkeystore endpoint:

{
  "username": "tomas44",
  "password": "foo123",
  "key_alg": "RSA",
  "key_spec": "2048"
}
TEXT

and cURL:

curl -X POST "https://localhost:8443/ejbca/ejbca-rest-api/v1/certificate/enrollkeystore" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{  \"username\": \"tomas44\",  \"password\": \"foo123\",  \"key_alg\": \"RSA\",  \"key_spec\": \"2048\"}"
TEXT

Add extension_data

For the certificate serial number, the parameter looks like CERTIFICATESERIALNUMBER=<serial number>. Start the number with '0x' to indicate that it is hexadecimal.

Example:

CERTIFICATESERIALNUMBER=8642378462375036 CERTIFICATESERIALNUMBER=0x5a53875acdaf24
CODE

For the certificate extension, the parameter look like  <oid>[.<type>]=value. The key '1.2.3.4' is same as the '1.2.3.4.value'.

Example:

1.2.840.113634.100.6.1.1=00aa00bb 1.2.3.4.value1=1234 1.2.3.4.value2=abcdef
CODE

For ETSI PSD2 QC Statement, the parameters (all required) look like QCETSIPSD2ROLESOFPSP=oid;name', QCETSIPSD2NCANAME='NCA Name', QCETSIPSD2NCAID='NCA ID. An optional CAB forum organization identifier parameter (as part of extended information) provided to the command with an example format like the following:

CABFORGANIZATIONIDENTIFIER=VATSE-123456789
CODE

The following displays example code on how to add extended information in the WS request:

ei.add(new ExtendedInformationWS (ExtendedInformation.CUSTOMDATA+ExtendedInformation.CUSTOM_REVOCATIONREASON,
Integer.toString(RevokeStatus.REVOKATION_REASON_CERTIFICATEHOLD)));
ei.add(new ExtendedInformationWS (ExtendedInformation.SUBJECTDIRATTRIBUTES, "DATEOFBIRTH=19761123"));
user.setExtendedInformation(ei);
CODE

which translates into:

customdata_REVOCATIONREASON=REVOKATION_REASON_UNSPECIFIED
subjectdirattributes="DATEOFBIRTH=19761123"
CODE

Other attributes can be found in ExtendedInformation, for example:

STARTTIME="May 26, 2009 9:52 AM" or "days:hours:minutes"
ENDTIME=like above	
CODE

Exporting Configuration with ConfigDump

Export and import of configurations support parameters like ignoreerrors, include, exclude, and so on. For more information about available parameters, see  Swagger UI, the generated REST API Reference, or  ConfigDump Tool.

The configuration can be exported in different ways: the whole configuration, by type, by type and setting, or as a ZIP file containing YAML formatted ConfigDump export.

Exporting All Configuration

Example cURL command for exporting all configuration as JSON format:

curl -X GET "https://localhost:8443/ejbca/ejbca-rest-api/v1/configdump?ignoreerrors=true&defaults=false&externalcas=false"  \
-H "accept: application/json"
BASH

Example cURL command for exporting all configuration as a ZIP file:

curl -X GET "https://localhost:8443/ejbca/ejbca-rest-api/v1/configdump/configdump.zip?ignoreerrors=false&defaults=false&externalcas=false"  \
-H "accept: application/zip"
BASH

Exporting Publishers via ConfigDump (/configdump/{type} resource)

Different types can be used (PUBLISHER for publishers, CRYPTOTOKEN for crypto tokens, etc). For a complete list of types, refer to the generated REST API Reference descriptions.

curl -X GET "https://localhost:8443/ejbca/ejbca-rest-api/v1/configdump/PUBLISHER?ignoreerrors=false&defaults=false&externalcas=false"  \
-H "accept: application/json"
BASH

Exporting a Publisher name "test" (/configdump/{type}/{setting} resource)

curl -X GET "https://localhost:8443/ejbca/ejbca-rest-api/v1/configdump/PUBLISHER/test?ignoreerrors=false&defaults=false"  \
-H "accept: application/json"
BASH

Importing Configuration with ConfigDump

JSON data for the body part of an import POST request follows the convention: attribute values are exactly the same as when importing and/or exporting through the ConfigDump CLI with YAML files.

{
  "<configuration type>": {
    "<configuration name>": {
      "<attribute field>": "<value>",
    },
	"<configuration name>": {
      "<attribute field>": "<value>",
    }
  }
}
JS

An example JSON body for importing a single approval profile:

{
  "approval-profiles": {
    "Test Approval Profile": {
      "Object Type": "Approval Profile",
      "Version": 1,
      "ID": 526448739,
      "Type": "ACCUMULATIVE_APPROVAL",
      "Name": "Test Approval Profile",
      "Approval Expiration Period": "8h",
      "Request Expiration Period": "8h",
      "Max Extension Time": "0d",
      "Allow Self-Approved Request Editing": false,
      "Number of Approvals Required": 1
    }
  }
}
JS

And the expected cURL command for the above JSON body: 

curl -X POST "https://localhost:8443/ejbca/ejbca-rest-api/v1/configdump?ignoreerrors=false&initialize=false&continue=false&overwrite=abort&resolve=abort"  \
-H "accept: application/json" -H "Content-Type: application/json" \
-d "{ \"approval-profiles\": { \"Test Approval Profile\": { \"Object Type\": \"Approval Profile\", \"Version\": 1, \"ID\": 526448739, \"Type\": \"ACCUMULATIVE_APPROVAL\", \"Name\": \"Test Approval Profile\", \"Approval Expiration Period\": \"8h\", \"Request Expiration Period\": \"8h\", \"Max Extension Time\": \"0d\", \"Allow Self-Approved Request Editing\": false, \"Number of Approvals Required\": 1 } }}"
BASH

Importing a ZIP file Configuration

# Prepare the ZIP file
cd <working-directory> 
zip -r configdump.zip .

# Example cURL command that uses above ZIP file (which has the folder/file structure an CLI ConfigDump would create)
curl -X POST "https://localhost:8443/ejbca/ejbca-rest-api/v1/configdump/configdump.zip" \ 
-H "accept: application/json" -H "Content-Type: multipart/form-data"  \
-F "zipfile=@configdump.zip;type=application/zip" -F "overwrite=abort" -F "resolve=abort"
BASH

Troubleshooting

Certificate Request Encoding

An exception like the following may be caused by an encoding issue:

IOException while decoding certificate request from PEM: -----END CERTIFICATE REQUEST

The issue can be resolved by manually replacing the linebreaks with \n.

Finding the Cause of Error Codes Returned to the Client

When you get an error message back, such as an HTTP 404 (BAD_REQUEST) the cause of the error can often be found in a message returned as part of the HTTP error. The full cause of the error is also typically visible in the server log file for administrators to see.

Converting DER format responses into PEM

Binary DER files have usually .cer, .crt or .der extensions, while PEM is strictly specified with PEM headers -----BEGIN / END CERTIFICATE----- and line breaks every 64 characters. More details in RFC7468.

Some REST calls return a DER certificate encoded in base64 within the JSON response body, in order to transfer the binary data in a JSON structure. It is identified with “response_format": "DER” in the JSON itself, and can be converted to PEM where required.

For instance, after a successful call to /v1/certificate/pkcs10enroll, the JSON output will contain a certificate object in base64, which can be extracted:

Process the JSON response with jq to extract the base64 DER data and output to a file

jq -r .certificate response_1617122570566.json > certificate-base64.b64
BASH

The base64 data can be decoded into the binary DER format:

Decode the DER back to binary

openssl base64 -d -A -in certificate-base64.b64 -out certificate-bin.crt
BASH

You can convert it to PEM, for example with openssl:

Convert DER to PEM using openssl

openssl x509 -inform der -in certificate-bin.crt -out certificate.pem
BASH

and openssl can also be used to back and forth between PEM and DER:

You could also convert from PEM to DER using openssl

openssl x509 -outform der -in certificate.pem -out certificate-bin.crt
BASH