jwt.h

Go to the documentation of this file.

/* Copyright (C) 2015-2023 Ben Collins <bcollins@maclara-llc.com>
   This file is part of the JWT C Library
 
   SPDX-License-Identifier:  MPL-2.0
   This Source Code Form is subject to the terms of the Mozilla Public
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
#ifndef JWT_H
#define JWT_H
 
#include <stdio.h>
#include <time.h>
 
#ifdef _MSC_VER
 
    #define DEPRECATED(func) __declspec(deprecated) func
 
    #define alloca _alloca
    #define strcasecmp _stricmp
    #define strdup _strdup
 
    #ifdef JWT_DLL_CONFIG
        #ifdef JWT_BUILD_SHARED_LIBRARY
            #define JWT_EXPORT __declspec(dllexport)
        #else
            #define JWT_EXPORT __declspec(dllimport)
        #endif
    #else
        #define JWT_EXPORT
    #endif
 
#else
 
    #define DEPRECATED(func) func __attribute__ ((deprecated))
    #define JWT_EXPORT
 
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct jwt jwt_t;
 
typedef struct jwt_valid jwt_valid_t;
 
typedef enum jwt_alg {
    JWT_ALG_NONE = 0,
    JWT_ALG_HS256,
    JWT_ALG_HS384,
    JWT_ALG_HS512,
    JWT_ALG_RS256,
    JWT_ALG_RS384,
    JWT_ALG_RS512,
    JWT_ALG_ES256,
    JWT_ALG_ES384,
    JWT_ALG_ES512,
#ifndef HAVE_OPENSSL
    JWT_ALG_PS256,
    JWT_ALG_PS384,
    JWT_ALG_PS512,
#endif
    JWT_ALG_TERM
} jwt_alg_t;
 
#define JWT_ALG_INVAL JWT_ALG_TERM
 
#define JWT_VALIDATION_SUCCESS      0x0000
#define JWT_VALIDATION_ERROR        0x0001  /* General failures */
#define JWT_VALIDATION_ALG_MISMATCH 0x0002
#define JWT_VALIDATION_EXPIRED      0x0004
#define JWT_VALIDATION_TOO_NEW      0x0008
#define JWT_VALIDATION_ISS_MISMATCH 0x0010
#define JWT_VALIDATION_SUB_MISMATCH 0x0020
#define JWT_VALIDATION_AUD_MISMATCH 0x0040
#define JWT_VALIDATION_GRANT_MISSING    0x0080
#define JWT_VALIDATION_GRANT_MISMATCH   0x0100
 
typedef void *(*jwt_malloc_t)(size_t);
typedef void *(*jwt_realloc_t)(void *, size_t);
typedef void (*jwt_free_t)(void *);
 
typedef struct {
    const unsigned char *jwt_key;
    int jwt_key_len;
} jwt_key_t;
 
typedef int (*jwt_key_p_t)(const jwt_t *, jwt_key_t *);
 
JWT_EXPORT int jwt_new(jwt_t **jwt);
 
JWT_EXPORT int jwt_decode(jwt_t **jwt, const char *token,
                     const unsigned char *key, int key_len);
 
JWT_EXPORT int jwt_decode_2(jwt_t **jwt, const char *token, jwt_key_p_t key_provider);
 
JWT_EXPORT void jwt_free(jwt_t *jwt);
 
JWT_EXPORT jwt_t *jwt_dup(jwt_t *jwt);
 
JWT_EXPORT const char *jwt_get_grant(jwt_t *jwt, const char *grant);
 
JWT_EXPORT long jwt_get_grant_int(jwt_t *jwt, const char *grant);
 
JWT_EXPORT int jwt_get_grant_bool(jwt_t *jwt, const char *grant);
 
JWT_EXPORT char *jwt_get_grants_json(jwt_t *jwt, const char *grant);
 
JWT_EXPORT int jwt_add_grant(jwt_t *jwt, const char *grant, const char *val);
 
JWT_EXPORT int jwt_add_grant_int(jwt_t *jwt, const char *grant, long val);
 
JWT_EXPORT int jwt_add_grant_bool(jwt_t *jwt, const char *grant, int val);
 
JWT_EXPORT int jwt_add_grants_json(jwt_t *jwt, const char *json);
 
JWT_EXPORT int jwt_del_grants(jwt_t *jwt, const char *grant);
 
JWT_EXPORT const char *jwt_get_header(jwt_t *jwt, const char *header);
 
JWT_EXPORT long jwt_get_header_int(jwt_t *jwt, const char *header);
 
JWT_EXPORT int jwt_get_header_bool(jwt_t *jwt, const char *header);
 
JWT_EXPORT char *jwt_get_headers_json(jwt_t *jwt, const char *header);
 
JWT_EXPORT int jwt_add_header(jwt_t *jwt, const char *header, const char *val);
 
JWT_EXPORT int jwt_add_header_int(jwt_t *jwt, const char *header, long val);
 
JWT_EXPORT int jwt_add_header_bool(jwt_t *jwt, const char *header, int val);
 
JWT_EXPORT int jwt_add_headers_json(jwt_t *jwt, const char *json);
 
JWT_EXPORT int jwt_del_headers(jwt_t *jwt, const char *header);
 
JWT_EXPORT int jwt_dump_fp(jwt_t *jwt, FILE *fp, int pretty);
 
JWT_EXPORT char *jwt_dump_str(jwt_t *jwt, int pretty);
 
JWT_EXPORT int jwt_encode_fp(jwt_t *jwt, FILE *fp);
 
JWT_EXPORT char *jwt_encode_str(jwt_t *jwt);
 
JWT_EXPORT void jwt_free_str(char *str);
 
JWT_EXPORT int jwt_set_alg(jwt_t *jwt, jwt_alg_t alg, const unsigned char *key, int len);
 
JWT_EXPORT jwt_alg_t jwt_get_alg(const jwt_t *jwt);
 
JWT_EXPORT const char *jwt_alg_str(jwt_alg_t alg);
 
JWT_EXPORT jwt_alg_t jwt_str_alg(const char *alg);
 
JWT_EXPORT int jwt_set_alloc(jwt_malloc_t pmalloc, jwt_realloc_t prealloc, jwt_free_t pfree);
 
JWT_EXPORT void jwt_get_alloc(jwt_malloc_t *pmalloc, jwt_realloc_t *prealloc, jwt_free_t *pfree);
 
JWT_EXPORT unsigned int jwt_validate(jwt_t *jwt, jwt_valid_t *jwt_valid);
 
JWT_EXPORT int jwt_valid_new(jwt_valid_t **jwt_valid, jwt_alg_t alg);
 
JWT_EXPORT void jwt_valid_free(jwt_valid_t *jwt_valid);
 
JWT_EXPORT unsigned int jwt_valid_get_status(jwt_valid_t *jwt_valid);
 
JWT_EXPORT time_t jwt_valid_get_nbf_leeway(jwt_valid_t *jwt_valid);
 
JWT_EXPORT time_t jwt_valid_get_exp_leeway(jwt_valid_t *jwt_valid);
 
JWT_EXPORT int jwt_valid_add_grant(jwt_valid_t *jwt_valid, const char *grant, const char *val);
 
JWT_EXPORT const char *jwt_valid_get_grant(jwt_valid_t *jwt_valid, const char *grant);
 
JWT_EXPORT int jwt_valid_add_grant_int(jwt_valid_t *jwt_valid, const char *grant, long val);
 
JWT_EXPORT long jwt_valid_get_grant_int(jwt_valid_t *jwt_valid, const char *grant);
 
JWT_EXPORT int jwt_valid_add_grant_bool(jwt_valid_t *jwt_valid, const char *grant, int val);
 
JWT_EXPORT int jwt_valid_get_grant_bool(jwt_valid_t *jwt_valid, const char *grant);
 
JWT_EXPORT int jwt_valid_add_grants_json(jwt_valid_t *jwt_valid, const char *json);
 
JWT_EXPORT char* jwt_valid_get_grants_json(jwt_valid_t *jwt_valid, const char *grant);
 
JWT_EXPORT int jwt_valid_del_grants(jwt_valid_t *jwt_valid, const char *grant);
 
JWT_EXPORT int jwt_valid_set_now(jwt_valid_t *jwt_valid, const time_t now);
 
JWT_EXPORT int jwt_valid_set_nbf_leeway(jwt_valid_t *jwt_valid, const time_t nbf_leeway);
 
JWT_EXPORT int jwt_valid_set_exp_leeway(jwt_valid_t *jwt_valid, const time_t exp_leeway);
 
JWT_EXPORT int jwt_valid_set_headers(jwt_valid_t *jwt_valid, int hdr);
 
JWT_EXPORT char *jwt_exception_str(unsigned int exceptions);
 
#ifdef __cplusplus
}
#endif
 
#endif /* JWT_H */