2019-04-18 14:27:27 +00:00
|
|
|
// clang-format off
|
2018-12-15 12:10:07 +00:00
|
|
|
/**
|
|
|
|
* Copyright FIDO Alliance, 2017
|
|
|
|
*
|
|
|
|
* Licensed under CC-BY:
|
|
|
|
* https://creativecommons.org/licenses/by/4.0/legalcode
|
|
|
|
*
|
|
|
|
* Editor: Jakob Ehrensvard, Yubico, jakob@yubico.com
|
|
|
|
*/
|
2015-11-02 23:08:18 +00:00
|
|
|
|
|
|
|
#ifndef __U2F_H_INCLUDED__
|
|
|
|
#define __U2F_H_INCLUDED__
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#ifdef _MSC_VER // Windows
|
|
|
|
typedef unsigned char uint8_t;
|
|
|
|
typedef unsigned short uint16_t;
|
|
|
|
typedef unsigned int uint32_t;
|
2015-11-02 23:08:18 +00:00
|
|
|
typedef unsigned long int uint64_t;
|
|
|
|
#else
|
|
|
|
#include <stdint.h>
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
2018-12-15 12:10:07 +00:00
|
|
|
extern "C" {
|
2015-11-02 23:08:18 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
// General constants
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#define U2F_EC_KEY_SIZE 32 // EC key size in bytes
|
|
|
|
#define U2F_EC_POINT_SIZE ((U2F_EC_KEY_SIZE * 2) + 1) // Size of EC point
|
|
|
|
#define U2F_MAX_KH_SIZE 128 // Max size of key handle
|
|
|
|
#define U2F_MAX_ATT_CERT_SIZE 2048 // Max size of attestation certificate
|
|
|
|
#define U2F_MAX_EC_SIG_SIZE 72 // Max size of DER coded EC signature
|
|
|
|
#define U2F_CTR_SIZE 4 // Size of counter field
|
|
|
|
#define U2F_APPID_SIZE 32 // Size of application id
|
|
|
|
#define U2F_CHAL_SIZE 32 // Size of challenge
|
2015-11-02 23:08:18 +00:00
|
|
|
|
|
|
|
#define ENC_SIZE(x) ((x + 7) & 0xfff8)
|
|
|
|
|
|
|
|
// EC (uncompressed) point
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#define U2F_POINT_UNCOMPRESSED 0x04 // Uncompressed point format
|
2015-11-02 23:08:18 +00:00
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
typedef struct __attribute__((packed)) {
|
|
|
|
uint8_t pointFormat; // Point type
|
|
|
|
uint8_t x[U2F_EC_KEY_SIZE]; // X-value
|
|
|
|
uint8_t y[U2F_EC_KEY_SIZE]; // Y-value
|
|
|
|
} U2F_EC_POINT;
|
2015-11-02 23:08:18 +00:00
|
|
|
|
|
|
|
// U2F native commands
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#define U2F_REGISTER 0x01 // Registration command
|
|
|
|
#define U2F_AUTHENTICATE 0x02 // Authenticate/sign command
|
|
|
|
#define U2F_VERSION 0x03 // Read version string command
|
2015-11-02 23:08:18 +00:00
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#define U2F_VENDOR_FIRST 0x40 // First vendor defined command
|
|
|
|
#define U2F_VENDOR_LAST 0xbf // Last vendor defined command
|
2015-11-02 23:08:18 +00:00
|
|
|
|
|
|
|
// U2F_CMD_REGISTER command defines
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#define U2F_REGISTER_ID 0x05 // Version 2 registration identifier
|
|
|
|
#define U2F_REGISTER_HASH_ID 0x00 // Version 2 hash identintifier
|
|
|
|
|
|
|
|
typedef struct __attribute__((packed)) {
|
|
|
|
uint8_t chal[U2F_CHAL_SIZE]; // Challenge
|
|
|
|
uint8_t appId[U2F_APPID_SIZE]; // Application id
|
|
|
|
} U2F_REGISTER_REQ;
|
|
|
|
|
|
|
|
typedef struct __attribute__((packed)) {
|
|
|
|
uint8_t registerId; // Registration identifier (U2F_REGISTER_ID_V2)
|
|
|
|
U2F_EC_POINT pubKey; // Generated public key
|
|
|
|
uint8_t keyHandleLen; // Length of key handle
|
|
|
|
uint8_t keyHandleCertSig[
|
|
|
|
U2F_MAX_KH_SIZE + // Key handle
|
|
|
|
U2F_MAX_ATT_CERT_SIZE + // Attestation certificate
|
|
|
|
U2F_MAX_EC_SIG_SIZE]; // Registration signature
|
|
|
|
} U2F_REGISTER_RESP;
|
2015-11-02 23:08:18 +00:00
|
|
|
|
|
|
|
// U2F_CMD_AUTHENTICATE command defines
|
|
|
|
|
|
|
|
// Authentication control byte
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#define U2F_AUTH_ENFORCE 0x03 // Enforce user presence and sign
|
|
|
|
#define U2F_AUTH_CHECK_ONLY 0x07 // Check only
|
|
|
|
#define U2F_AUTH_FLAG_TUP 0x01 // Test of user presence set
|
|
|
|
|
|
|
|
typedef struct __attribute__((packed)) {
|
|
|
|
uint8_t chal[U2F_CHAL_SIZE]; // Challenge
|
|
|
|
uint8_t appId[U2F_APPID_SIZE]; // Application id
|
|
|
|
uint8_t keyHandleLen; // Length of key handle
|
|
|
|
uint8_t keyHandle[U2F_MAX_KH_SIZE]; // Key handle
|
|
|
|
} U2F_AUTHENTICATE_REQ;
|
|
|
|
|
|
|
|
typedef struct __attribute__((packed)) {
|
|
|
|
uint8_t flags; // U2F_AUTH_FLAG_ values
|
|
|
|
uint8_t ctr[U2F_CTR_SIZE]; // Counter field (big-endian)
|
|
|
|
uint8_t sig[U2F_MAX_EC_SIG_SIZE]; // Signature
|
|
|
|
} U2F_AUTHENTICATE_RESP;
|
2015-11-02 23:08:18 +00:00
|
|
|
|
|
|
|
// Command status responses
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#define U2F_SW_NO_ERROR 0x9000 // SW_NO_ERROR
|
|
|
|
#define U2F_SW_WRONG_LENGTH 0x6700 // SW_WRONG_LENGTH
|
|
|
|
#define U2F_SW_WRONG_DATA 0x6A80 // SW_WRONG_DATA
|
|
|
|
#define U2F_SW_CONDITIONS_NOT_SATISFIED 0x6985 // SW_CONDITIONS_NOT_SATISFIED
|
|
|
|
#define U2F_SW_COMMAND_NOT_ALLOWED 0x6986 // SW_COMMAND_NOT_ALLOWED
|
|
|
|
#define U2F_SW_INS_NOT_SUPPORTED 0x6D00 // SW_INS_NOT_SUPPORTED
|
|
|
|
#define U2F_SW_CLA_NOT_SUPPORTED 0x6E00 // SW_CLA_NOT_SUPPORTED
|
2015-11-02 23:08:18 +00:00
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2018-12-15 12:10:07 +00:00
|
|
|
#endif // __U2F_H_INCLUDED__
|