ctap_hid.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.
 */
 
#ifndef FIDO2_CTAP_TRANSPORT_HID_CTAP_HID_H
#define FIDO2_CTAP_TRANSPORT_HID_CTAP_HID_H
 
#include <stdint.h>
 
#include "usb/usbus/hid.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CTAP_HID_INIT_PAYLOAD_SIZE  (CONFIG_USBUS_HID_INTERRUPT_EP_SIZE - 7)    
#define CTAP_HID_CONT_PAYLOAD_SIZE  (CONFIG_USBUS_HID_INTERRUPT_EP_SIZE - 5)    
#define CTAP_HID_PROTOCOL_VERSION 0x02
 
#define CTAP_HID_INIT_PACKET 0x80   
#define CTAP_HID_CONT_PACKET 0x00   
#define CTAP_HID_INIT_NONCE_SIZE 8
 
#ifdef CONFIG_FIDO2_CTAP_TRANSPORT_HID_TRANSACTION_TIMEOUT
#define CTAP_HID_TRANSACTION_TIMEOUT_MS (CONFIG_FIDO2_CTAP_TRANSPORT_HID_TRANSACTION_TIMEOUT)
#else
#define CTAP_HID_TRANSACTION_TIMEOUT_MS (500)
#endif
 
#define CTAP_HID_BUFFER_SIZE 7609
 
#define CTAP_HID_COMMAND_PING       (0x01 | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_MSG        (0x03 | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_LOCK       (0x04 | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_INIT       (0x06 | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_WINK       (0x08 | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_CBOR       (0x10 | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_CANCEL     (0x11 | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_KEEPALIVE  (0x3b | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_COMMAND_ERROR      (0x3f | CTAP_HID_INIT_PACKET)   
#define CTAP_HID_CAPABILITY_WINK 0x01   
#define CTAP_HID_CAPABILITY_CBOR 0x04   
#define CTAP_HID_CAPABILITY_NMSG 0x08   
#define CTAP_HID_OK                   0x00      
#define CTAP_HID_ERR_INVALID_CMD      0x01      
#define CTAP_HID_ERR_INVALID_PAR      0x02      
#define CTAP_HID_ERR_INVALID_LEN      0x03      
#define CTAP_HID_ERR_INVALID_SEQ      0x04      
#define CTAP_HID_ERR_MSG_TIMEOUT      0x05      
#define CTAP_HID_ERR_CHANNEL_BUSY     0x06      
#define CTAP_HID_ERR_LOCK_REQUIRED    0x0a      
#define CTAP_HID_ERR_INVALID_CHANNEL  0x0b      
#define CTAP_HID_ERR_OTHER            0x7f      
#define CTAP_HID_STATUS_PROCESSING 0x01     
#define CTAP_HID_STATUS_UPNEEDED   0x02     
#define CTAP_HID_CIDS_MAX 0x08
 
#define CTAP_HID_WINK_DELAY 400
 
#define CTAP_HID_BROADCAST_CID 0xffffffff
 
#define CTAP_HID_BUFFER_STATUS_BUFFERING    0x00    
#define CTAP_HID_BUFFER_STATUS_DONE         0x01    
#define CTAP_HID_BUFFER_STATUS_ERROR        0x02    
typedef struct {
    uint8_t cmd;                                    
    uint8_t bcnth;                                  
    uint8_t bcntl;                                  
    uint8_t payload[CTAP_HID_INIT_PAYLOAD_SIZE];    
} ctap_hid_init_pkt_t;
 
typedef struct {
    uint8_t seq;                                    
    uint8_t payload[CTAP_HID_CONT_PAYLOAD_SIZE];    
} ctap_hid_cont_pkt_t;
 
typedef struct {
    uint32_t cid;                   
    union {
        ctap_hid_init_pkt_t init;   
        ctap_hid_cont_pkt_t cont;   
    };
} ctap_hid_pkt_t;
 
typedef struct __attribute__((packed)){
    uint8_t nonce[CTAP_HID_INIT_NONCE_SIZE];    
    uint32_t cid;                               
    uint8_t protocol_version;                   
    uint8_t version_major;                      
    uint8_t version_minor;                      
    uint8_t build_version;                      
    uint8_t capabilities;                       
} ctap_hid_init_resp_t;
 
typedef struct {
    bool taken;                             
    uint32_t cid;                           
    uint32_t last_used;                     
} ctap_hid_cid_t;
 
void fido2_ctap_transport_hid_init(event_queue_t *queue);
 
void fido2_ctap_transport_hid_handle_packet(void *pkt_raw);
 
void fido2_ctap_transport_hid_check_timeouts(void);
 
bool fido2_ctap_transport_hid_should_cancel(void);
 
#ifdef __cplusplus
}
#endif
#endif /* FIDO2_CTAP_TRANSPORT_HID_CTAP_HID_H */