ctap_cbor.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include "fido2/ctap/ctap.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define CTAP_CBOR_INFO_MAP_SZ 0x06

#define CTAP_CBOR_ATTESTATION_MAP_SZ 0x03

#define CTAP_CBOR_ATTESTATION_STMT_MAP_SZ 0x02

#define CTAP_CBOR_CRED_DESC_MAP_SZ 0x02

#define CTAP_CBOR_PIN_TOKEN_MAP_SZ 0x01

#define CTAP_CBOR_USER_ENTITY_MAP_SZ 0x01

#define CTAP_CBOR_COSE_KEY_MAP_SZ 0x05

#define CTAP_CBOR_KEY_AGREEMENT_MAP_SZ 0x01

#define CTAP_CBOR_RETRIES_MAP_SZ 0x01

#define CTAP_CBOR_ATT_STMT_AUTH_DATA_SZ 0x134

#define CTAP_CBOR_MAP_MAX_KEY_LEN 0x10

#define CTAP_CBOR_MAX_CREDENTIAL_TYPE_LEN 0x10

#define CTAP_CBOR_STR_PACKED "packed"           
#define CTAP_CBOR_STR_ALG "alg"                 
#define CTAP_CBOR_STR_SIG "sig"                 
#define CTAP_CBOR_STR_ID "id"                   
#define CTAP_CBOR_STR_TYPE "type"               
#define CTAP_CBOR_STR_PUBLIC_KEY "public-key"   
#define CTAP_CBOR_STR_USER_VERIFIED "uv"        
#define CTAP_CBOR_STR_USER_PRESENT "up"         
#define CTAP_CBOR_STR_RESIDENT_KEY "rk"         
#define CTAP_CBOR_STR_NAME "name"               
#define CTAP_CBOR_STR_ICON "icon"               
#define CTAP_CBOR_DISPLAY_NAME "displayName"    

#define CTAP_CBOR_CP_RESP_KEY_AGREEMENT  0x01   
#define CTAP_CBOR_CP_PIN_TOKEN_RESP      0x02   
#define CTAP_CBOR_CP_RETRIES_RESP        0x03   

#define CTAP_CBOR_MC_REQ_CLIENT_DATA_HASH    0x01   
#define CTAP_CBOR_MC_REQ_RP                  0x02   
#define CTAP_CBOR_MC_REQ_USER                0x03   
#define CTAP_CBOR_MC_REQ_PUB_KEY_CRED_PARAMS 0x04   
#define CTAP_CBOR_MC_REQ_EXCLUDE_LIST        0x05   
#define CTAP_CBOR_MC_REQ_EXTENSIONS          0x06   
#define CTAP_CBOR_MC_REQ_OPTIONS             0x07   
#define CTAP_CBOR_MC_REQ_PIN_AUTH            0x08   
#define CTAP_CBOR_MC_REQ_PIN_PROTOCOL        0x09   

#define CTAP_CBOR_GET_INFO_RESP_VERSIONS         0x01   
#define CTAP_CBOR_GET_INFO_RESP_EXTENSIONS       0x02   
#define CTAP_CBOR_GET_INFO_RESP_AAGUID           0x03   
#define CTAP_CBOR_GET_INFO_RESP_OPTIONS          0x04   
#define CTAP_CBOR_GET_INFO_RESP_MAX_MSG_SIZE     0x05   
#define CTAP_CBOR_GET_INFO_RESP_PIN_PROTOCOLS    0x06   

#define CTAP_CBOR_VERSION_STRING_FIDO_PRE "FIDO_2_1_PRE"    
#define CTAP_CBOR_VERSION_STRING_FIDO     "FIDO_2_0"        
#define CTAP_CBOR_VERSION_STRING_U2F_V2   "U2F_V2"          

#define CTAP_CBOR_MC_RESP_FMT                0x01   
#define CTAP_CBOR_MC_RESP_AUTH_DATA          0x02   
#define CTAP_CBOR_MC_RESP_ATT_STMT           0x03   

#define CTAP_CBOR_GA_REQ_RP_ID               0x01   
#define CTAP_CBOR_GA_REQ_CLIENT_DATA_HASH    0x02   
#define CTAP_CBOR_GA_REQ_ALLOW_LIST          0x03   
#define CTAP_CBOR_GA_REQ_EXTENSIONS          0x04   
#define CTAP_CBOR_GA_REQ_OPTIONS             0x05   
#define CTAP_CBOR_GA_REQ_PIN_AUTH            0x06   
#define CTAP_CBOR_GA_REQ_PIN_PROTOCOL        0x07   

#define CTAP_CBOR_GA_RESP_CREDENTIAL             0x01   
#define CTAP_CBOR_GA_RESP_AUTH_DATA              0x02   
#define CTAP_CBOR_GA_RESP_SIGNATURE              0x03   
#define CTAP_CBOR_GA_RESP_USER                   0x04   
#define CTAP_CBOR_GA_RESP_NUMBER_OF_CREDENTIALS  0x05   

#define CTAP_CBOR_CP_REQ_PIN_PROTOCOL    0x01   
#define CTAP_CBOR_CP_REQ_SUB_COMMAND     0x02   
#define CTAP_CBOR_CP_REQ_KEY_AGREEMENT   0x03   
#define CTAP_CBOR_CP_REQ_PIN_AUTH        0x04   
#define CTAP_CBOR_CP_REQ_NEW_PIN_ENC     0x05   
#define CTAP_CBOR_CP_REQ_PIN_HASH_ENC    0x06   

ctap_status_code_t fido2_ctap_cbor_parse_make_credential_req(ctap_make_credential_req_t *req,
                                              const uint8_t *req_raw, size_t len);

ctap_status_code_t fido2_ctap_cbor_parse_get_assertion_req(ctap_get_assertion_req_t *req,
                                            const uint8_t *req_raw, size_t len);

 
ctap_status_code_t fido2_ctap_cbor_encode_info(const ctap_info_t *info);
ctap_status_code_t fido2_ctap_cbor_parse_client_pin_req(ctap_client_pin_req_t *req,
                                         const uint8_t *req_raw, size_t len);
ctap_status_code_t fido2_ctap_cbor_encode_attestation_object(const ctap_auth_data_t *auth_data,
                                              const uint8_t *client_data_hash,
                                              ctap_resident_key_t *rk);

ctap_status_code_t fido2_ctap_cbor_encode_assertion_object(const ctap_auth_data_header_t *auth_data,
                                            const uint8_t *client_data_hash,
                                            ctap_resident_key_t *rk,
                                            uint8_t valid_cred_count);
ctap_status_code_t fido2_ctap_cbor_encode_key_agreement(const ctap_public_key_cose_t *key);

ctap_status_code_t fido2_ctap_cbor_encode_pin_token(uint8_t *token, size_t len);

ctap_status_code_t fido2_ctap_cbor_encode_retries(uint8_t tries_left);

size_t fido2_ctap_cbor_get_buffer_size(const uint8_t *buf);

void fido2_ctap_cbor_init_encoder(uint8_t *buf, size_t len);
 
#ifdef __cplusplus
}
#endif