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

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