Annotation of src/usr.bin/ssh/sshsig.h, Revision 1.2
1.1 djm 1: /*
2: * Copyright (c) 2019 Google LLC
3: *
4: * Permission to use, copy, modify, and distribute this software for any
5: * purpose with or without fee is hereby granted, provided that the above
6: * copyright notice and this permission notice appear in all copies.
7: *
8: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15: */
16:
17: #ifndef SSHSIG_H
18: #define SSHSIG_H
19:
20: struct sshbuf;
21: struct sshkey;
22:
23: typedef int sshsig_signer(struct sshkey *, u_char **, size_t *,
24: const u_char *, size_t, const char *, u_int, void *);
25:
1.2 ! djm 26: /* Buffer-oriented API */
! 27:
1.1 djm 28: /*
1.2 ! djm 29: * Creates a detached SSH signature for a given buffer.
1.1 djm 30: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
31: * out is populated with the detached signature, or NULL on failure.
32: */
1.2 ! djm 33: int sshsig_signb(struct sshkey *key, const char *hashalg,
1.1 djm 34: const struct sshbuf *message, const char *sig_namespace,
35: struct sshbuf **out, sshsig_signer *signer, void *signer_ctx);
36:
37: /*
1.2 ! djm 38: * Verifies that a detached signature is valid and optionally returns key
! 39: * used to sign via argument.
! 40: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
! 41: */
! 42: int sshsig_verifyb(struct sshbuf *signature,
! 43: const struct sshbuf *message, const char *sig_namespace,
! 44: struct sshkey **sign_keyp);
! 45:
! 46: /* File/FD-oriented API */
! 47:
! 48: /*
1.1 djm 49: * Creates a detached SSH signature for a given file.
50: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
51: * out is populated with the detached signature, or NULL on failure.
52: */
53: int sshsig_sign_fd(struct sshkey *key, const char *hashalg,
54: int fd, const char *sig_namespace, struct sshbuf **out,
55: sshsig_signer *signer, void *signer_ctx);
56:
57: /*
58: * Verifies that a detached signature over a file is valid and optionally
59: * returns key used to sign via argument.
60: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
61: */
62: int sshsig_verify_fd(struct sshbuf *signature, int fd,
63: const char *sig_namespace, struct sshkey **sign_keyp);
1.2 ! djm 64:
! 65: /* Utility functions */
1.1 djm 66:
67: /*
68: * Return a base64 encoded "ASCII armoured" version of a raw signature.
69: */
70: int sshsig_armor(const struct sshbuf *blob, struct sshbuf **out);
71:
72: /*
73: * Decode a base64 encoded armoured signature to a raw signature.
74: */
75: int sshsig_dearmor(struct sshbuf *sig, struct sshbuf **out);
76:
77: /*
78: * Checks whether a particular key/principal/namespace is permitted by
79: * an allowed_keys file. Returns 0 on success.
80: */
81: int sshsig_check_allowed_keys(const char *path, const struct sshkey *sign_key,
82: const char *principal, const char *ns);
83:
84: #endif /* SSHSIG_H */