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.7

1.7     ! djm         1: /* $OpenBSD: sk-api.h,v 1.6 2019/12/30 09:24:45 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.2       markus     37:
1.1       djm        38: struct sk_enroll_response {
                     39:        uint8_t *public_key;
                     40:        size_t public_key_len;
                     41:        uint8_t *key_handle;
                     42:        size_t key_handle_len;
                     43:        uint8_t *signature;
                     44:        size_t signature_len;
                     45:        uint8_t *attestation_cert;
                     46:        size_t attestation_cert_len;
                     47: };
                     48:
                     49: struct sk_sign_response {
                     50:        uint8_t flags;
                     51:        uint32_t counter;
                     52:        uint8_t *sig_r;
                     53:        size_t sig_r_len;
                     54:        uint8_t *sig_s;
                     55:        size_t sig_s_len;
                     56: };
                     57:
1.4       djm        58: struct sk_resident_key {
1.7     ! djm        59:        uint32_t alg;
1.4       djm        60:        size_t slot;
                     61:        char *application;
                     62:        struct sk_enroll_response key;
                     63: };
                     64:
1.7     ! djm        65: struct sk_option {
        !            66:        char *name;
        !            67:        char *value;
        !            68:        uint8_t required;
        !            69: };
        !            70:
        !            71: #define SSH_SK_VERSION_MAJOR           0x00040000 /* current API version */
1.1       djm        72: #define SSH_SK_VERSION_MAJOR_MASK      0xffff0000
                     73:
                     74: /* Return the version of the middleware API */
                     75: uint32_t sk_api_version(void);
                     76:
                     77: /* Enroll a U2F key (private key generation) */
1.7     ! djm        78: int sk_enroll(uint32_t alg, const uint8_t *challenge, size_t challenge_len,
1.5       djm        79:     const char *application, uint8_t flags, const char *pin,
1.7     ! djm        80:     struct sk_option **options, struct sk_enroll_response **enroll_response);
1.1       djm        81:
                     82: /* Sign a challenge */
1.7     ! djm        83: int sk_sign(uint32_t alg, const uint8_t *message, size_t message_len,
1.1       djm        84:     const char *application, const uint8_t *key_handle, size_t key_handle_len,
1.7     ! djm        85:     uint8_t flags, const char *pin, struct sk_option **options,
        !            86:     struct sk_sign_response **sign_response);
1.4       djm        87:
                     88: /* Enumerate all resident keys */
1.7     ! djm        89: int sk_load_resident_keys(const char *pin, struct sk_option **options,
1.4       djm        90:     struct sk_resident_key ***rks, size_t *nrks);
1.1       djm        91:
                     92: #endif /* _SK_API_H */