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

1.1     ! djm         1: /* $OpenBSD$ */
        !             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
        !            26:
        !            27: struct sk_enroll_response {
        !            28:        uint8_t *public_key;
        !            29:        size_t public_key_len;
        !            30:        uint8_t *key_handle;
        !            31:        size_t key_handle_len;
        !            32:        uint8_t *signature;
        !            33:        size_t signature_len;
        !            34:        uint8_t *attestation_cert;
        !            35:        size_t attestation_cert_len;
        !            36: };
        !            37:
        !            38: struct sk_sign_response {
        !            39:        uint8_t flags;
        !            40:        uint32_t counter;
        !            41:        uint8_t *sig_r;
        !            42:        size_t sig_r_len;
        !            43:        uint8_t *sig_s;
        !            44:        size_t sig_s_len;
        !            45: };
        !            46:
        !            47: #define SSH_SK_VERSION_MAJOR           0x00010000 /* current API version */
        !            48: #define SSH_SK_VERSION_MAJOR_MASK      0xffff0000
        !            49:
        !            50: /* Return the version of the middleware API */
        !            51: uint32_t sk_api_version(void);
        !            52:
        !            53: /* Enroll a U2F key (private key generation) */
        !            54: int sk_enroll(const uint8_t *challenge, size_t challenge_len,
        !            55:     const char *application, uint8_t flags,
        !            56:     struct sk_enroll_response **enroll_response);
        !            57:
        !            58: /* Sign a challenge */
        !            59: int sk_sign(const uint8_t *message, size_t message_len,
        !            60:     const char *application, const uint8_t *key_handle, size_t key_handle_len,
        !            61:     uint8_t flags, struct sk_sign_response **sign_response);
        !            62:
        !            63: #endif /* _SK_API_H */