Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Tenant Policy Configuration

Every Debbie policy configuration file has two to well defined sections that must be configured in order to validate an End User Certificate for a given tenant.


Note
titleCase sensitive

All policy configuration field values are case sensitive.




The following fields are general definitions for a tenant policy.


FieldRequiredDescriptionExample
urlyesURL where the policy validation service for a tenant is available. If several policies have the same URL in the policy configuration file, only the first one found will work. For example, the policy will be accessible on "/acme".acme
versionyesPolicy configuration version.1.0.0
descriptionyesPolicy configuration description.Acme Pilot
statusyes

Indicates if this policy is enabled. This field allows to have several definitions but only keep one of them active. Possible values are enabled or disabled.

enabled
encodingnoThis field is used to select the character set used by the signed text, especially when it has been generated on a Web page that can be browser dependent. The possible values are all those Character Sets that can be defined in every platform. If none is indicated, "UTF-8" is taken as default.ISO-8859-1
certPolicyLevelyesSets the signature's certificate validation level. See Policy Level table below for more details.1


The following table represents the possible values for the certPolicyLevel field.


LevelValueDescription
0NONEThere is no evaluation of the signing certificate. Any certificate is accepted.
1TRUSTEDThere is no evaluation of the signing certificate, ocspEnabled and crlEnabled must be false on the trust anchors.
2CRLThe signer's validation result is evaluated only by CRL, ocspEnabled must be false and crlEnabled must be true on the trust anchors.
3OCSP then CRLThe signer's validation result is evaluated by OCSP, if this fails is validated by CRL, ocspEnabled and crlEnabled must be true on the trust anchors. If this option is active, and any of the certificates is validated through CRL, then the final result of the validation will be WARNING.
4OCSPThe signer's validation result is evaluated only by OCSP, ocspEnabled must be true and crlEnabled must be false on the trust anchors. If this option is active, and any of the certificates cannot be validated by OCSP, then the final result of the validation will be ERROR.


Code Block
languagegroovy
titleSample acme.policy.json contents
{
    "url": "acme",
    "version": "1.0.0",
    "description": "Acme Pilot",
    "status": "enabled",
    "certPolicyLevel": "3",
    "trust": [
       ...
    ] 
}




A trust anchor represents the list of trusted Certificate Authorities needed to validate an End-User certificate. Following are the possible fields that can be used to define a trust anchor for a given Certificate Authority.


FieldDescriptionExample
caCertCertificate file for the Certification Authority in DER format.config/certstore/CA.root.ClassB.G1.cer
certFilterDetails a specific filter defined on this policy. It can be by any field of the Subject or Issuer. The example  restricts the policy to accept exclusively End-User Certificates where the O (Organization) field included in the Subject field contains the text: “Acme Inc”.filters=subject.rfc2254:(O=Acme Inc)


Code Block
languagegroovy
titleSample "tenant.policy.json" trust anchors definitions
{
    ...
    "trust": [
        {
            "caCert": "config/certstore/CertiSur.root.ClassB.G1.pilot.509.cer"
        },
        {
            "caCert": "config/certstore/CertiSur.shared.ClassB.G1.pilot.509.cer",
            "certFilter": "filters=subject.rfc2254:(O=Acme Inc)"            
        }
    ]
}




FieldDescriptionExample
crlEnabledCRL validation for the certificates issued by caCert is enabled. Possible values are true or false.true
crlURLSee crlURL table below for more details.http://pki-crl.symauth.com/ca_4..3/LatestCRL.crl


The following table represents the possible values for the "crlURL" field.


CRL FieldDescriptionExample
URLIf Internet access is available from the server where Debbie is installed, it is advisable to configure this field with the CRL URL. Debbie will download it every time it is needed or if the previously downloaded CRL has expired.http://pki-crl.symauth.com/ca\_45a68..3/LatestCRL.crl
file URIIf there is no Internet access from the server where Debbie is installed, the CRL can be downloaded from another server and copied to the the location cacheDir defined on Debbie configuration file. The downloaded CRL must be referenced with this variable.file://http\_\_\_pki-crl\_symauth\_com\_ca\_45..d3\_LatestCRL\_crl




FieldDescriptionExample
ocspEnabledOCSP validation for the certificates issued by caCert is enabled. Possible values are true or false.true
ocspURLOCSP Responder URL.http://pki-ocsp.digicert.com
ocspCertOCSP Responder signing certiticate. This is necessary to verify the OCSP Response.config/certstore/Sant..OCSP_responder.prod.509
testUserCertEnd User certificate to validate with the OCSP Responder. This is used to check if the OCSP Responder is available.config/certstore/San..test_user.prod.509



A sub policy represents a set of modifiers that applies to an especific end entity trust anchor.



FieldRequiredDescriptionExampleDefault
urlyesURL where the sub policy validation service for a tenant is available. If several sub policies have the same URL in the policy configuration file, only the first one found will work. For example, the sub policy will be accessible on "/acme/renew".renew
certPolicyLevelnoOverrides the signature's certificate validation level. See Policy Level table below for more details.1Parent policy value
ignoreExpiredCertificatenoSets Debbie validator to take expired certificates as valid ones. truefalse
ignoreSigningTimenoSets Debbie validator to disable checks of the signature date.truefalse
signatureValidityWindownoSets a validity window to check the signature date. -5:30not set
checkCoversWholeDocumentnoSets Debbie validator to give an error message in case a signature does not cover a whole PDF document.truefalse
certValidityWindownoSets a validity window to check the certificate expiration date. This allows to take an expired certificate as valid if it is in that window.-30:30not set


Code Block
languagegroovy
titleSample "tenant.policy.json" sub policies definitions
{
    ...
	"subpolicy": [
	    {
	        "url": "padessignature",
	        "ignoreExpiredCertificate": "true",
	        "ignoreSigningTime": "true",
	        "certPolicyLevel": "2",
	        "signatureValidityWindow": "-5:30",
	        "checkCoversWholeDocument": "true"
	    },
	    {
	        "url": "renew",
	        "certValidityWindow": "-30:30"
	    }
	] 
}




Following is the content of the "acme.policy.json" demo configuration file included in with the validation service distribution.


Code Block
languagegroovy
titleSample Debbie policy configuration file
{
    "url": "acme",
    "version": "3.0.0",
    "description": "Acme Pilot",
    "status": "enabled",
    "certPolicyLevel": "0",
    "trust": [
        {
            "caCert": "config/certstore/CertiSur.root.ClassB.G1.pilot.509.cer"
        },
        {
            "caCert": "config/certstore/CertiSur.shared.ClassB.G1.pilot.509.cer",
            "certFilter": "filters=subject.rfc2254:(O=Acme Inc)"            
        }
    ],
	"subpolicy": [
	    {
	        "url": "padessignature",
	        "ignoreExpiredCertificate": "false",
	        "ignoreSigningTime": "false",
	        "certPolicyLevel": "2",
	        "signatureValidityWindow": "-5:30",
	        "checkCoversWholeDocument": "true"
	    },
	    {
	        "url": "renew",
	        "certValidityWindow": "-30:30"
	    }
	] 
}