Return to sk-api.h CVS log

Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/sk-api.h, Revision 1.12

1.12    ! djm         1: /* $OpenBSD: sk-api.h,v 1.11 2020/09/09 03:08:01 djm Exp $ */
1.1       djm         2: /*
                      3:  * Copyright (c) 2019 Google LLC
                      4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
                      6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
                      8:  *
                      9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16:  */
                     17:
                     18: #ifndef _SK_API_H
                     19: #define _SK_API_H 1
                     20:
                     21: #include <stddef.h>
                     22: #include <stdint.h>
                     23:
                     24: /* Flags */
                     25: #define SSH_SK_USER_PRESENCE_REQD      0x01
1.3       djm        26: #define SSH_SK_USER_VERIFICATION_REQD  0x04
                     27: #define SSH_SK_RESIDENT_KEY            0x20
1.1       djm        28:
1.2       markus     29: /* Algs */
                     30: #define SSH_SK_ECDSA                   0x00
                     31: #define SSH_SK_ED25519                 0x01
1.6       djm        32:
                     33: /* Error codes */
                     34: #define SSH_SK_ERR_GENERAL             -1
                     35: #define SSH_SK_ERR_UNSUPPORTED         -2
                     36: #define SSH_SK_ERR_PIN_REQUIRED                -3
1.8       djm        37: #define SSH_SK_ERR_DEVICE_NOT_FOUND    -4
1.2       markus     38:
1.1       djm        39: struct sk_enroll_response {
                     40:        uint8_t *public_key;
                     41:        size_t public_key_len;
                     42:        uint8_t *key_handle;
                     43:        size_t key_handle_len;
                     44:        uint8_t *signature;
                     45:        size_t signature_len;
                     46:        uint8_t *attestation_cert;
                     47:        size_t attestation_cert_len;
1.11      djm        48:        uint8_t *authdata;
                     49:        size_t authdata_len;
1.1       djm        50: };
                     51:
                     52: struct sk_sign_response {
                     53:        uint8_t flags;
                     54:        uint32_t counter;
                     55:        uint8_t *sig_r;
                     56:        size_t sig_r_len;
                     57:        uint8_t *sig_s;
                     58:        size_t sig_s_len;
                     59: };
                     60:
1.4       djm        61: struct sk_resident_key {
1.7       djm        62:        uint32_t alg;
1.4       djm        63:        size_t slot;
                     64:        char *application;
                     65:        struct sk_enroll_response key;
1.10      djm        66:        uint8_t flags;
1.4       djm        67: };
                     68:
1.7       djm        69: struct sk_option {
                     70:        char *name;
                     71:        char *value;
                     72:        uint8_t required;
                     73: };
                     74:
1.11      djm        75: #define SSH_SK_VERSION_MAJOR           0x00070000 /* current API version */
1.1       djm        76: #define SSH_SK_VERSION_MAJOR_MASK      0xffff0000
                     77:
                     78: /* Return the version of the middleware API */
                     79: uint32_t sk_api_version(void);
                     80:
                     81: /* Enroll a U2F key (private key generation) */
1.7       djm        82: int sk_enroll(uint32_t alg, const uint8_t *challenge, size_t challenge_len,
1.5       djm        83:     const char *application, uint8_t flags, const char *pin,
1.7       djm        84:     struct sk_option **options, struct sk_enroll_response **enroll_response);
1.1       djm        85:
                     86: /* Sign a challenge */
1.12    ! djm        87: int sk_sign(uint32_t alg, const uint8_t *data, size_t data_len,
1.1       djm        88:     const char *application, const uint8_t *key_handle, size_t key_handle_len,
1.7       djm        89:     uint8_t flags, const char *pin, struct sk_option **options,
                     90:     struct sk_sign_response **sign_response);
1.4       djm        91:
                     92: /* Enumerate all resident keys */
1.7       djm        93: int sk_load_resident_keys(const char *pin, struct sk_option **options,
1.4       djm        94:     struct sk_resident_key ***rks, size_t *nrks);
1.1       djm        95:
                     96: #endif /* _SK_API_H */