decode.h

Go to the documentation of this file.

/*
   Copyright 2020 Raphael Beck
 
   Licensed 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 L8W8JWT_DECODE_H
#define L8W8JWT_DECODE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "algs.h"
#include "claim.h"
#include "version.h"
#include "retcodes.h"
#include "timehelper.h"
#include <stddef.h>
#include <stdint.h>
 
#ifndef L8W8JWT_MAX_KEY_SIZE
#define L8W8JWT_MAX_KEY_SIZE 8192
#endif
 
enum l8w8jwt_validation_result {
    L8W8JWT_VALID = (unsigned)0,
 
    L8W8JWT_ISS_FAILURE = (unsigned)1 << (unsigned)0,
 
    L8W8JWT_SUB_FAILURE = (unsigned)1 << (unsigned)1,
 
    L8W8JWT_AUD_FAILURE = (unsigned)1 << (unsigned)2,
 
    L8W8JWT_JTI_FAILURE = (unsigned)1 << (unsigned)3,
 
    L8W8JWT_EXP_FAILURE = (unsigned)1 << (unsigned)4,
 
    L8W8JWT_NBF_FAILURE = (unsigned)1 << (unsigned)5,
 
    L8W8JWT_IAT_FAILURE = (unsigned)1 << (unsigned)6,
 
    L8W8JWT_SIGNATURE_VERIFICATION_FAILURE = (unsigned)1 << (unsigned)7,
 
    L8W8JWT_TYP_FAILURE = (unsigned)1 << (unsigned)8
};
 
struct l8w8jwt_decoding_params
{
    char* jwt;
 
    size_t jwt_length;
 
    int alg;
 
    char* validate_iss;
 
    size_t validate_iss_length;
 
    char* validate_sub;
 
    size_t validate_sub_length;
 
    char* validate_aud;
 
    size_t validate_aud_length;
 
    char* validate_jti;
 
    size_t validate_jti_length;
 
    int validate_exp;
 
    int validate_nbf;
 
    int validate_iat;
 
    uint8_t exp_tolerance_seconds;
 
    uint8_t nbf_tolerance_seconds;
 
    uint8_t iat_tolerance_seconds;
 
    unsigned char* verification_key;
 
    size_t verification_key_length;
 
    char* validate_typ;
 
    size_t validate_typ_length;
};
 
L8W8JWT_API void l8w8jwt_decoding_params_init(struct l8w8jwt_decoding_params* params);
 
L8W8JWT_API int l8w8jwt_validate_decoding_params(struct l8w8jwt_decoding_params* params);
 
L8W8JWT_API int l8w8jwt_decode(struct l8w8jwt_decoding_params* params, enum l8w8jwt_validation_result* out_validation_result, struct l8w8jwt_claim** out_claims, size_t* out_claims_length);
 
L8W8JWT_API int l8w8jwt_decode_raw(struct l8w8jwt_decoding_params* params, enum l8w8jwt_validation_result* out_validation_result, char** out_header, size_t* out_header_length, char** out_payload, size_t* out_payload_length, uint8_t** out_signature, size_t* out_signature_length);
 
L8W8JWT_API int l8w8jwt_decode_raw_no_validation(struct l8w8jwt_decoding_params* params, char** out_header, size_t* out_header_length, char** out_payload, size_t* out_payload_length, uint8_t** out_signature, size_t* out_signature_length);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // L8W8JWT_DECODE_H