apr_jose.h

Go to the documentation of this file.

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef APR_JOSE_H
#define APR_JOSE_H

#include "apr.h"
#include "apr_pools.h"
#include "apu_errno.h"
#include "apr_strings.h"
#include "apr_buckets.h"
#include "apr_json.h"

#ifdef __cplusplus
extern "C" {
#endif

#define APR_JOSE_JWA_HS256 "HS256"

#define APR_JOSE_JWA_HS384 "HS384"

#define APR_JOSE_JWA_HS512 "HS512"

#define APR_JOSE_JWA_RS256 "RS256"

#define APR_JOSE_JWA_RS384 "RS384"

#define APR_JOSE_JWA_RS512 "RS512"

#define APR_JOSE_JWA_ES256 "ES256"

#define APR_JOSE_JWA_ES384 "ES384"

#define APR_JOSE_JWA_ES512 "ES512"

#define APR_JOSE_JWA_PS256 "PS256"

#define APR_JOSE_JWA_PS384 "PS384"

#define APR_JOSE_JWA_PS512 "PS512"

#define APR_JOSE_JWA_NONE "none"

#define APR_JOSE_JWK_KEY_TYPE "kty"

#define APR_JOSE_JWK_PUBLIC_KEY_USE "use"

#define APR_JOSE_JWK_KEY_OPERATIONS "key_ops"

#define APR_JOSE_JWK_KEYS "keys"

#define APR_JOSE_JWKSE_ALGORITHM "alg"

#define APR_JOSE_JWE_ENCRYPTION "enc"

#define APR_JOSE_JWE_COMPRESSION "zip"

#define APR_JOSE_JWSE_JWK_SET_URL "jku"

#define APR_JOSE_JWSE_JWK "jwk"

#define APR_JOSE_JWKSE_KEYID "kid"

#define APR_JOSE_JWKSE_X509_URL "x5u"

#define APR_JOSE_JWKSE_X509_CHAIN "x5c"

#define APR_JOSE_JWKSE_X509_SHA1_THUMBPRINT "x5t"

#define APR_JOSE_JWKSE_X509_SHA256_THUMBPRINT "x5t#S256"

#define APR_JOSE_JWSE_TYPE "typ"

#define APR_JOSE_JWSE_CONTENT_TYPE "cty"

#define APR_JOSE_JWSE_CRITICAL "crit"

#define APR_JOSE_JWS_PAYLOAD "payload"

#define APR_JOSE_JWS_SIGNATURES "signatures"

#define APR_JOSE_JWSE_PROTECTED "protected"

#define APR_JOSE_JWSE_HEADER "header"

#define APR_JOSE_JWS_SIGNATURE "signature"

#define APR_JOSE_JWE_UNPROTECTED "unprotected"

#define APR_JOSE_JWE_CIPHERTEXT "ciphertext"

#define APR_JOSE_JWE_RECIPIENTS "recipients"

#define APR_JOSE_JWE_EKEY "encrypted_key"

#define APR_JOSE_JWE_IV "iv"

#define APR_JOSE_JWE_TAG "tag"

#define APR_JOSE_JWE_AAD "aad"

#define APR_JOSE_JWT_ISSUER "iss"

#define APR_JOSE_JWT_SUBJECT "sub"

#define APR_JOSE_JWT_AUDIENCE "aud"

#define APR_JOSE_JWT_EXPIRATION_TIME "exp"

#define APR_JOSE_JWT_NOT_BEFORE "nbf"

#define APR_JOSE_JWT_ISSUED_AT "iat"

#define APR_JOSE_JWT_ID "jti"

#define APR_JOSE_JWSE_TYPE_JWT "JWT"

#define APR_JOSE_FLAG_NONE    0

#define APR_JOSE_FLAG_DECODE_ALL    1

#define APR_JOSE_FLAG_BREAK    2

typedef struct apr_jose_t apr_jose_t;

typedef enum apr_jose_type_e {
    APR_JOSE_TYPE_NONE = 0,
    APR_JOSE_TYPE_JWK = 1,
    APR_JOSE_TYPE_JWKS,
    APR_JOSE_TYPE_JWS,
    APR_JOSE_TYPE_JWS_JSON,
    APR_JOSE_TYPE_JWE,
    APR_JOSE_TYPE_JWE_JSON,
    APR_JOSE_TYPE_JWT,
    APR_JOSE_TYPE_DATA,
    APR_JOSE_TYPE_TEXT,
    APR_JOSE_TYPE_JSON
} apr_jose_type_e;

typedef struct apr_jose_data_t {
    const unsigned char *data;
    apr_size_t len;
} apr_jose_data_t;

typedef struct apr_jose_text_t {
    const char *text;
    apr_size_t len;
} apr_jose_text_t;

typedef struct apr_jose_json_t {
    apr_json_value_t *json;
} apr_jose_json_t;

typedef struct apr_jose_jwk_t {
    apr_json_value_t *key;
} apr_jose_jwk_t;

typedef struct apr_jose_jwks_t {
    apr_json_value_t *keys;
} apr_jose_jwks_t;

typedef struct apr_jose_signature_t {
    apr_json_value_t *header;
    apr_json_value_t *protected_header;
    apr_jose_data_t sig;
    apr_status_t status;
} apr_jose_signature_t;

typedef struct apr_jose_jws_t {
    apr_jose_signature_t *signature;
    apr_array_header_t *signatures;
    apr_jose_t *payload;
} apr_jose_jws_t;

typedef struct apr_jose_encryption_t {
    apr_json_value_t *unprotected;
    apr_json_value_t *protected;
    apr_jose_text_t protected64;
    apr_jose_data_t iv;
    apr_jose_data_t aad;
    apr_jose_text_t aad64;
    apr_jose_data_t cipher;
    apr_jose_data_t tag;
} apr_jose_encryption_t;

typedef struct apr_jose_recipient_t {
    apr_json_value_t *header;
    apr_jose_data_t ekey;
    apr_status_t status;
} apr_jose_recipient_t;

typedef struct apr_jose_jwe_t {
    apr_jose_recipient_t *recipient;
    apr_array_header_t *recipients;
    apr_jose_encryption_t *encryption;
    apr_jose_t *payload;
} apr_jose_jwe_t;

typedef struct apr_jose_jwt_t {
    apr_json_value_t *claims;
} apr_jose_jwt_t;

struct apr_jose_t {
    apr_pool_t *pool;
    const char *typ;
    const char *cty;
    apu_err_t result;
    apr_jose_type_e type;
    union {
        apr_jose_jwk_t *jwk;
        apr_jose_jwks_t *jwks;
        apr_jose_jws_t *jws;
        apr_jose_jwe_t *jwe;
        apr_jose_jwt_t *jwt;
        apr_jose_data_t *data;
        apr_jose_text_t *text;
        apr_jose_json_t *json;
    } jose;
};

typedef struct apr_jose_cb_t {
    apr_status_t (*encrypt)(apr_bucket_brigade *bb, apr_jose_t *jose,
            apr_jose_recipient_t *recipient, apr_jose_encryption_t *encryption,
            void *ctx, apr_pool_t *pool);
    apr_status_t (*decrypt)(apr_bucket_brigade *bb, apr_jose_t *jose,
            apr_jose_recipient_t *recipient, apr_jose_encryption_t *encryption,
            apr_json_value_t *header, apr_jose_text_t *ph64,
            apr_jose_text_t *aad64, void *ctx, int *dflags, apr_pool_t *pool);
    apr_status_t (*sign)(apr_bucket_brigade *bb, apr_jose_t *jose,
            apr_jose_signature_t *signature, void *ctx, apr_pool_t *pool);
    apr_status_t (*verify)(apr_bucket_brigade *bb, apr_jose_t *jose,
            apr_jose_signature_t *signature, void *ctx, int *vflags,
            apr_pool_t *pool);
    void *ctx;
} apr_jose_cb_t;

APR_DECLARE(apu_err_t *) apr_jose_error(apr_jose_t *jose)
        __attribute__((nonnull(1)));

APR_DECLARE(apr_jose_t *) apr_jose_make(apr_jose_t *jose, apr_jose_type_e type,
        apr_pool_t *pool)
        __attribute__((nonnull(3)));

APR_DECLARE(apr_jose_t *) apr_jose_jwk_make(apr_jose_t *jose,
        apr_json_value_t *key, apr_pool_t *pool)
        __attribute__((nonnull(3)));

APR_DECLARE(apr_jose_t *) apr_jose_jwks_make(apr_jose_t *jose,
        apr_json_value_t *keys, apr_pool_t *pool)
        __attribute__((nonnull(3)));

APR_DECLARE(apr_jose_signature_t *) apr_jose_signature_make(
        apr_jose_signature_t *signature, apr_json_value_t *header,
        apr_json_value_t *protected, apr_pool_t *pool)
        __attribute__((nonnull(4)));

APR_DECLARE(apr_jose_recipient_t *) apr_jose_recipient_make(apr_jose_recipient_t *recipient,
        apr_json_value_t *unprotected, apr_pool_t *pool)
        __attribute__((nonnull(3)));

APR_DECLARE(apr_jose_encryption_t *) apr_jose_encryption_make(apr_jose_encryption_t *encryption,
        apr_json_value_t *unprotected, apr_json_value_t *protected,
        apr_pool_t *pool)
        __attribute__((nonnull(4)));

APR_DECLARE(apr_jose_t *) apr_jose_jwe_make(apr_jose_t *jose,
        apr_jose_recipient_t *recipient, apr_array_header_t *recipients,
        apr_jose_encryption_t *encryption, apr_jose_t *payload,
        apr_pool_t *pool)
        __attribute__((nonnull(6)));

APR_DECLARE(apr_jose_t *) apr_jose_jwe_json_make(apr_jose_t *jose,
        apr_jose_recipient_t *recipient,
        apr_array_header_t *recipients, apr_jose_encryption_t *encryption,
        apr_jose_t *payload, apr_pool_t *pool)
        __attribute__((nonnull(6)));

APR_DECLARE(apr_jose_t *) apr_jose_jws_make(apr_jose_t *jose,
        apr_jose_signature_t *signature, apr_array_header_t *signatures,
        apr_jose_t *payload, apr_pool_t *pool)
        __attribute__((nonnull(5)));

APR_DECLARE(apr_jose_t *) apr_jose_jws_json_make(apr_jose_t *jose,
        apr_jose_signature_t *signature, apr_array_header_t *signatures,
        apr_jose_t *payload, apr_pool_t *pool)
        __attribute__((nonnull(5)));

APR_DECLARE(apr_jose_t *) apr_jose_jwt_make(apr_jose_t *jose,
        apr_json_value_t *claims, apr_pool_t *pool)
        __attribute__((nonnull(3)));

APR_DECLARE(apr_jose_t *) apr_jose_data_make(apr_jose_t *jose, const char *typ,
        const unsigned char *in, apr_size_t inlen, apr_pool_t *pool)
        __attribute__((nonnull(5)));

APR_DECLARE(apr_jose_t *) apr_jose_text_make(apr_jose_t *jose, const char *cty,
        const char *in, apr_size_t inlen, apr_pool_t *pool)
        __attribute__((nonnull(5)));

APR_DECLARE(apr_jose_t *) apr_jose_json_make(apr_jose_t *jose, const char *cty,
        apr_json_value_t *json, apr_pool_t *pool)
        __attribute__((nonnull(4)));

APR_DECLARE(apr_status_t) apr_jose_encode(apr_bucket_brigade *brigade,
        apr_brigade_flush flush, void *ctx, apr_jose_t *jose,
        apr_jose_cb_t *cb, apr_pool_t *pool)
        __attribute__((nonnull(1, 4, 6)));

APR_DECLARE(apr_status_t) apr_jose_decode(apr_jose_t **jose, const char *typ,
        apr_bucket_brigade *brigade, apr_jose_cb_t *cb, int level, int flags,
        apr_pool_t *pool)
        __attribute__((nonnull(1, 3, 7)));


#ifdef __cplusplus
}
#endif

#endif /* APR_JOSE_H */