X509 Certificate Validator

Introduction

Use this valve to validate a X.509 v3 certificate.

Performs the following validations (in specified order):

1. Validity (notBefore/notAfter)
2. PKIX path ("certificate chain")
3. Signature

Note

This valve is a part of the item iteration API meaning that it operates on the current item set. For more information on item iteration, see Item.

Valve operates on items if available. During item iteration the validation result ("certificate status") will be set on the current item and must be asserted later in pipe. If no items are available pipe will fail if validation fails.

Certificate status values:

• GOOD
• EXPIRED
• NOT_YET_VALID
• INVALID_PATH
• INVALID_SIGNATURE

Configuration

Note

Valve name: X509CertificateValidator

Properties

Name	Description	Default	Mandatory	Expanded
src	X509 certificate in PEM format.
dest	Name of item property receiving validation status. Only used in item iteration mode.	"cert_status"
now	Instant in ISO-format for validating certificate expiry. Supports property expansion.	Default: current date/time
truststore	Trust store configuration object. Trust store is used for validating the certificate path.
truststore.path	Path to trust store (Mandatory unless "data" is specified.
truststore.data	Base64 encoded trust store (Mandatory unless "path" is specified)
truststore.password	Trust store password
truststore.type		"PKCS12"

Example

{
  "name" : "X509CertificateValidator",
  "config" : {
    "src" : "${request.pem}",
    "truststore" : {
      "path": "config/truststore.jks",
      "password": "secret",
      "type": "JKS"
    }
  }
}

Certificate validity

It is possible to check certificate validity for any point in time by setting the now configuration property. If not set, now will default to now (i.e the current time).