summaryrefslogtreecommitdiff
path: root/src/mongo/crypto/rsa_public_key.h
blob: ea8d78f3a24c4db4979f64d1bea8cc27863f7b06 (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
/**
 *    Copyright (C) 2022-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include <string>
#include <vector>

#include "mongo/base/data_range.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobjbuilder.h"

namespace mongo::crypto {

/**
 * Provides an interface for managing parameters to an RSA signing operation.
 * Note that this key contains public material only, and is not suitable for decryption.
 */
class RsaPublicKey {
public:
    /**
     * Creates an `RsaPublicKey` instance identified by the opaque string name {keyId}.
     * The RSA operation parameters of {E} and {N} must be passed as Base64URL encoded values (RFC
     * 4648 ยง5).
     */
    RsaPublicKey(StringData keyId, ConstDataRange e, ConstDataRange n);
    std::size_t getKeySizeBytes() const {
        return _n.size();
    }

    ConstDataRange getE() const {
        return ConstDataRange(_e);
    }

    ConstDataRange getN() const {
        return ConstDataRange(_n);
    }

    StringData getKeyId() const {
        return _keyId;
    }

    void appendToBSON(BSONObjBuilder* builder) const;
    BSONObj toBSON() const {
        BSONObjBuilder builder;
        appendToBSON(&builder);
        return builder.obj();
    }

private:
    std::string _keyId;
    std::vector<std::uint8_t> _e;
    std::vector<std::uint8_t> _n;
};

}  // namespace mongo::crypto