Annotation of src/usr.bin/ssh/sshsig.h, Revision 1.4
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;
1.3 djm 22: struct sshsigopt;
1.1 djm 23:
24: typedef int sshsig_signer(struct sshkey *, u_char **, size_t *,
1.4 ! djm 25: const u_char *, size_t, const char *, const char *, u_int, void *);
1.1 djm 26:
1.2 djm 27: /* Buffer-oriented API */
28:
1.1 djm 29: /*
1.2 djm 30: * Creates a detached SSH signature for a given buffer.
1.1 djm 31: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
32: * out is populated with the detached signature, or NULL on failure.
33: */
1.2 djm 34: int sshsig_signb(struct sshkey *key, const char *hashalg,
1.4 ! djm 35: const char *sk_provider, const struct sshbuf *message,
! 36: const char *sig_namespace, struct sshbuf **out,
! 37: sshsig_signer *signer, void *signer_ctx);
1.1 djm 38:
39: /*
1.2 djm 40: * Verifies that a detached signature is valid and optionally returns key
41: * used to sign via argument.
42: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
43: */
44: int sshsig_verifyb(struct sshbuf *signature,
45: const struct sshbuf *message, const char *sig_namespace,
46: struct sshkey **sign_keyp);
47:
48: /* File/FD-oriented API */
49:
50: /*
1.1 djm 51: * Creates a detached SSH signature for a given file.
52: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
53: * out is populated with the detached signature, or NULL on failure.
54: */
55: int sshsig_sign_fd(struct sshkey *key, const char *hashalg,
1.4 ! djm 56: const char *sk_provider, int fd, const char *sig_namespace,
! 57: struct sshbuf **out, sshsig_signer *signer, void *signer_ctx);
1.1 djm 58:
59: /*
60: * Verifies that a detached signature over a file is valid and optionally
61: * returns key used to sign via argument.
62: * Returns 0 on success or a negative SSH_ERR_* error code on failure.
63: */
64: int sshsig_verify_fd(struct sshbuf *signature, int fd,
65: const char *sig_namespace, struct sshkey **sign_keyp);
1.2 djm 66:
67: /* Utility functions */
1.1 djm 68:
69: /*
70: * Return a base64 encoded "ASCII armoured" version of a raw signature.
71: */
72: int sshsig_armor(const struct sshbuf *blob, struct sshbuf **out);
73:
74: /*
75: * Decode a base64 encoded armoured signature to a raw signature.
76: */
77: int sshsig_dearmor(struct sshbuf *sig, struct sshbuf **out);
78:
79: /*
80: * Checks whether a particular key/principal/namespace is permitted by
81: * an allowed_keys file. Returns 0 on success.
82: */
83: int sshsig_check_allowed_keys(const char *path, const struct sshkey *sign_key,
84: const char *principal, const char *ns);
1.3 djm 85:
86: /* Parse zero or more allowed_keys signature options */
87: struct sshsigopt *sshsigopt_parse(const char *opts,
88: const char *path, u_long linenum, const char **errstrp);
89:
90: /* Free signature options */
91: void sshsigopt_free(struct sshsigopt *opts);
1.1 djm 92:
93: #endif /* SSHSIG_H */