xref: /freebsd/contrib/libfido2/src/fido/credman.h (revision 5d3e7166)
1 /*
2  * Copyright (c) 2019-2021 Yubico AB. All rights reserved.
3  * Use of this source code is governed by a BSD-style
4  * license that can be found in the LICENSE file.
5  */
6 
7 #ifndef _FIDO_CREDMAN_H
8 #define _FIDO_CREDMAN_H
9 
10 #include <stdint.h>
11 #include <stdlib.h>
12 
13 #ifdef _FIDO_INTERNAL
14 #include "blob.h"
15 #include "fido/err.h"
16 #include "fido/param.h"
17 #include "fido/types.h"
18 #else
19 #include <fido.h>
20 #include <fido/err.h>
21 #include <fido/param.h>
22 #endif
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif /* __cplusplus */
27 
28 #ifdef _FIDO_INTERNAL
29 struct fido_credman_metadata {
30 	uint64_t rk_existing;
31 	uint64_t rk_remaining;
32 };
33 
34 struct fido_credman_single_rp {
35 	fido_rp_t rp_entity;
36 	fido_blob_t rp_id_hash;
37 };
38 
39 struct fido_credman_rp {
40 	struct fido_credman_single_rp *ptr;
41 	size_t n_alloc; /* number of allocated entries */
42 	size_t n_rx;    /* number of populated entries */
43 };
44 
45 struct fido_credman_rk {
46 	fido_cred_t *ptr;
47 	size_t n_alloc; /* number of allocated entries */
48 	size_t n_rx;    /* number of populated entries */
49 };
50 #endif
51 
52 typedef struct fido_credman_metadata fido_credman_metadata_t;
53 typedef struct fido_credman_rk fido_credman_rk_t;
54 typedef struct fido_credman_rp fido_credman_rp_t;
55 
56 const char *fido_credman_rp_id(const fido_credman_rp_t *, size_t);
57 const char *fido_credman_rp_name(const fido_credman_rp_t *, size_t);
58 
59 const fido_cred_t *fido_credman_rk(const fido_credman_rk_t *, size_t);
60 const unsigned char *fido_credman_rp_id_hash_ptr(const fido_credman_rp_t *,
61     size_t);
62 
63 fido_credman_metadata_t *fido_credman_metadata_new(void);
64 fido_credman_rk_t *fido_credman_rk_new(void);
65 fido_credman_rp_t *fido_credman_rp_new(void);
66 
67 int fido_credman_del_dev_rk(fido_dev_t *, const unsigned char *, size_t,
68     const char *);
69 int fido_credman_get_dev_metadata(fido_dev_t *, fido_credman_metadata_t *,
70     const char *);
71 int fido_credman_get_dev_rk(fido_dev_t *, const char *, fido_credman_rk_t *,
72     const char *);
73 int fido_credman_get_dev_rp(fido_dev_t *, fido_credman_rp_t *, const char *);
74 int fido_credman_set_dev_rk(fido_dev_t *, fido_cred_t *, const char *);
75 
76 size_t fido_credman_rk_count(const fido_credman_rk_t *);
77 size_t fido_credman_rp_count(const fido_credman_rp_t *);
78 size_t fido_credman_rp_id_hash_len(const fido_credman_rp_t *, size_t);
79 
80 uint64_t fido_credman_rk_existing(const fido_credman_metadata_t *);
81 uint64_t fido_credman_rk_remaining(const fido_credman_metadata_t *);
82 
83 void fido_credman_metadata_free(fido_credman_metadata_t **);
84 void fido_credman_rk_free(fido_credman_rk_t **);
85 void fido_credman_rp_free(fido_credman_rp_t **);
86 
87 #ifdef __cplusplus
88 } /* extern "C" */
89 #endif /* __cplusplus */
90 
91 #endif /* !_FIDO_CREDMAN_H */
92