summaryrefslogtreecommitdiffstats
path: root/include/rekey/rnp_key_store.h
blob: 04faabf75fa4145a8adbd5c1b702d268cc5d3dc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
 * Copyright (c) 2017, [Ribose Inc](https://www.ribose.com).
 * All rights reserved.
 *
 * This code is originally derived from software contributed to
 * The NetBSD Foundation by Alistair Crooks (agc@netbsd.org), and
 * carried further by Ribose Inc (https://www.ribose.com).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef KEY_STORE_H_
#define KEY_STORE_H_

#include <stdint.h>
#include <stdbool.h>
#include "rnp.h"
#include "librepgp/stream-common.h"
#include "pgp-key.h"
#include <string>
#include <list>
#include <map>
#include <unordered_map>
#include <memory>
#include "librekey/kbx_blob.hpp"
#include "sec_profile.hpp"

/* Key import status. Order of elements is important. */
typedef enum pgp_key_import_status_t {
    PGP_KEY_IMPORT_STATUS_UNKNOWN = 0,
    PGP_KEY_IMPORT_STATUS_UNCHANGED,
    PGP_KEY_IMPORT_STATUS_UPDATED,
    PGP_KEY_IMPORT_STATUS_NEW,
} pgp_key_import_status_t;

typedef enum pgp_sig_import_status_t {
    PGP_SIG_IMPORT_STATUS_UNKNOWN = 0,
    PGP_SIG_IMPORT_STATUS_UNKNOWN_KEY,
    PGP_SIG_IMPORT_STATUS_UNCHANGED,
    PGP_SIG_IMPORT_STATUS_NEW
} pgp_sig_import_status_t;

typedef std::unordered_map<pgp_fingerprint_t, std::list<pgp_key_t>::iterator> pgp_key_fp_map_t;

typedef struct rnp_key_store_t {
    std::string            path;
    pgp_key_store_format_t format;
    rnp::SecurityContext & secctx;
    bool                   disable_validation =
      false; /* do not automatically validate keys, added to this key store */

    std::list<pgp_key_t>                     keys;
    pgp_key_fp_map_t                         keybyfp;
    std::vector<std::unique_ptr<kbx_blob_t>> blobs;

    ~rnp_key_store_t();
    rnp_key_store_t(rnp::SecurityContext &ctx)
        : path(""), format(PGP_KEY_STORE_UNKNOWN), secctx(ctx){};
    rnp_key_store_t(pgp_key_store_format_t format,
                    const std::string &    path,
                    rnp::SecurityContext & ctx);
    /* make sure we use only empty constructor */
    rnp_key_store_t(rnp_key_store_t &&src) = delete;
    rnp_key_store_t &operator=(rnp_key_store_t &&) = delete;
    rnp_key_store_t(const rnp_key_store_t &src) = delete;
    rnp_key_store_t &operator=(const rnp_key_store_t &) = delete;
} rnp_key_store_t;

bool rnp_key_store_load_from_path(rnp_key_store_t *, const pgp_key_provider_t *key_provider);
bool rnp_key_store_load_from_src(rnp_key_store_t *,
                                 pgp_source_t *,
                                 const pgp_key_provider_t *key_provider);

bool rnp_key_store_write_to_path(rnp_key_store_t *);
bool rnp_key_store_write_to_dst(rnp_key_store_t *, pgp_dest_t *);

void rnp_key_store_clear(rnp_key_store_t *);

size_t rnp_key_store_get_key_count(const rnp_key_store_t *);

/**
 * @brief Add key to the keystore, copying it.
 *
 * @param keyring allocated keyring, cannot be NULL.
 * @param key key to be added, cannot be NULL.
 * @return pointer to the added key or NULL if failed.
 */
pgp_key_t *rnp_key_store_add_key(rnp_key_store_t *keyring, pgp_key_t *key);

pgp_key_t *rnp_key_store_import_key(rnp_key_store_t *,
                                    pgp_key_t *,
                                    bool,
                                    pgp_key_import_status_t *);

/**
 * @brief Get signer's key from key store.
 *
 * @param store populated key store, cannot be NULL.
 * @param sig signature, cannot be NULL.
 * @return pointer to pgp_key_t structure if key was found or NULL otherwise.
 */
pgp_key_t *rnp_key_store_get_signer_key(rnp_key_store_t *store, const pgp_signature_t *sig);

pgp_sig_import_status_t rnp_key_store_import_key_signature(rnp_key_store_t *      keyring,
                                                           pgp_key_t *            key,
                                                           const pgp_signature_t *sig);

/**
 * @brief Import revocation or direct-key signature to the keyring.
 *
 * @param keyring populated keyring, cannot be NULL.
 * @param sig signature to import.
 * @param status signature import status will be put here, if not NULL.
 * @return pointer to the key to which this signature belongs (or NULL if key was not found)
 */
pgp_key_t *rnp_key_store_import_signature(rnp_key_store_t *        keyring,
                                          const pgp_signature_t *  sig,
                                          pgp_sig_import_status_t *status);

bool rnp_key_store_remove_key(rnp_key_store_t *, const pgp_key_t *, bool);

bool rnp_key_store_get_key_grip(const pgp_key_material_t *, pgp_key_grip_t &grip);

const pgp_key_t *rnp_key_store_get_key_by_fpr(const rnp_key_store_t *,
                                              const pgp_fingerprint_t &fpr);
pgp_key_t *      rnp_key_store_get_key_by_fpr(rnp_key_store_t *, const pgp_fingerprint_t &fpr);
pgp_key_t *      rnp_key_store_get_primary_key(rnp_key_store_t *, const pgp_key_t *);
pgp_key_t *rnp_key_store_search(rnp_key_store_t *, const pgp_key_search_t *, pgp_key_t *);

#endif /* KEY_STORE_H_ */