schemas.schema-form.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-policy-http-signature Show documentation

Description of the HTTP Signature Gravitee Policy

There is a newer version: 1.7.0

Show newest version

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "scheme" : {
      "title": "Scheme",
      "description": "Signature Scheme",
      "type" : "string",
      "default": "AUTHORIZATION",
      "enum" : [
        "AUTHORIZATION",
        "SIGNATURE"
      ],
      "x-schema-form": {
        "type": "select",
        "titleMap": {
          "AUTHORIZATION": "\"Signature\" HTTP Authentication Scheme",
          "SIGNATURE": "\"Signature\" HTTP Header"
        }
      },
      "gioConfig": {
        "banner": {
          "title": "Scheme",
          "text": "AUTHORIZATION: \"Signature\" HTTP Authentication Scheme
SIGNATURE: \"Signature\" HTTP Header"
        }
      }
    },
    "secret": {
      "title": "Secret",
      "description": "The secret key used to sign (support EL).",
      "type": "string"
    },
    "algorithms" : {
      "title": "Supported Algorithms",
      "description": "A list of supported HMAC digest algorithms.",
      "type" : "array",
      "items" : {
        "type" : "string",
        "title": "Algorithm",
        "default": "HMAC_SHA256",
        "enum" : [
          "HMAC_SHA1",
          "HMAC_SHA256",
          "HMAC_SHA384",
          "HMAC_SHA512"
        ]
      }
    },
    "enforceHeaders" : {
      "type": "array",
      "title": "Enforce Headers",
      "description": "List of headers the consumer must at least use for HTTP signature creation.",
      "items": {
        "type": "string",
        "title": "Header"
      }
    },
    "clockSkew": {
      "title": "Clock Skew",
      "default": 30,
      "description": "Clock Skew in seconds to prevent replay attacks.",
      "type": "integer"
    },
    "decodeSignature": {
      "title": "Decode the signature",
      "default": false,
      "description": "Decode the signature before comparing it.",
      "type": "boolean"
    },
    "strictMode": {
      "title": "Validate the RFC 2617",
      "default": true,
      "description": "Does not accept non quoted strings.",
      "type": "boolean"
    }
  },
  "required": [
    "scheme",
    "secret"
  ]
}