account.hh 4.64 KB
Newer Older
Mark Haines's avatar
Mark Haines committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* Copyright 2015 OpenMarket Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
15
16
#ifndef OLM_ACCOUNT_HH_
#define OLM_ACCOUNT_HH_
17

18
#include "olm/list.hh"
19
#include "olm/crypto.h"
20
#include "olm/error.h"
21
22
23

#include <cstdint>

24
namespace olm {
25
26


27
struct IdentityKeys {
28
29
    _olm_ed25519_key_pair ed25519_key;
    _olm_curve25519_key_pair curve25519_key;
30
31
32
};

struct OneTimeKey {
33
    std::uint32_t id;
34
    bool published;
35
    _olm_curve25519_key_pair key;
36
37
38
39
40
};


static std::size_t const MAX_ONE_TIME_KEYS = 100;

41

42
struct Account {
43
    Account();
44
45
    IdentityKeys identity_keys;
    List<OneTimeKey, MAX_ONE_TIME_KEYS> one_time_keys;
46
    std::uint32_t next_one_time_key_id;
47
    OlmErrorCode last_error;
48
49
50
51

    /** Number of random bytes needed to create a new account */
    std::size_t new_account_random_length();

52
53
    /** Create a new account. Returns std::size_t(-1) on error. If the number of
     * random bytes is too small then last_error will be NOT_ENOUGH_RANDOM */
54
    std::size_t new_account(
55
56
57
        uint8_t const * random, std::size_t random_length
    );

58
    /** Number of bytes needed to output the identity keys for this account */
59
    std::size_t get_identity_json_length();
60
61

    /** Output the identity keys for this account as JSON in the following
62
     * format:
63
     *
64
65
     *    {"curve25519":"<43 base64 characters>"
     *    ,"ed25519":"<43 base64 characters>"
66
67
     *    }
     *
68
69
70
     *
     * Returns the size of the JSON written or std::size_t(-1) on error.
     * If the buffer is too small last_error will be OUTPUT_BUFFER_TOO_SMALL. */
71
    std::size_t get_identity_json(
72
        std::uint8_t * identity_json, std::size_t identity_json_length
73
74
    );

75
76
77
78
79
80
81
82
83
84
85
86
87
    /**
     * The length of an ed25519 signature in bytes.
     */
    std::size_t signature_length();

    /**
     * Signs a message with the ed25519 key for this account.
     */
    std::size_t sign(
        std::uint8_t const * message, std::size_t message_length,
        std::uint8_t * signature, std::size_t signature_length
    );

88
89
90
    /** Number of bytes needed to output the one time keys for this account */
    std::size_t get_one_time_keys_json_length();

91
92
    /** Output the one time keys that haven't been published yet as JSON:
     *
93
94
95
     *  {"curve25519":
     *  ["<6 byte key id>":"<43 base64 characters>"
     *  ,"<6 byte key id>":"<43 base64 characters>"
96
     *  ...
97
     *  ]
98
99
     *  }
     *
100
101
102
103
104
105
106
     * Returns the size of the JSON written or std::size_t(-1) on error.
     * If the buffer is too small last_error will be OUTPUT_BUFFER_TOO_SMALL.
     */
    std::size_t get_one_time_keys_json(
        std::uint8_t * one_time_json, std::size_t one_time_json_length
    );

107
108
109
110
111
112
113
    /** Mark the current list of one_time_keys as being published. They
     * will no longer be returned by get_one_time_keys_json_length(). */
    std::size_t mark_keys_as_published();

    /** The largest number of one time keys this account can store. */
    std::size_t max_number_of_one_time_keys();

114
115
    /** The number of random bytes needed to generate a given number of new one
     * time keys. */
116
117
118
119
120
121
122
123
124
125
126
127
128
    std::size_t generate_one_time_keys_random_length(
        std::size_t number_of_keys
    );

    /** Generates a number of new one time keys. If the total number of keys
     * stored by this account exceeds max_number_of_one_time_keys() then the
     * old keys are discarded. Returns std::size_t(-1) on error. If the number
     * of random bytes is too small then last_error will be NOT_ENOUGH_RANDOM */
    std::size_t generate_one_time_keys(
        std::size_t number_of_keys,
        std::uint8_t const * random, std::size_t random_length
    );

129
    /** Lookup a one time key with the given public key */
130
    OneTimeKey const * lookup_key(
131
        _olm_curve25519_public_key const & public_key
132
    );
133

134
    /** Remove a one time key with the given public key */
135
    std::size_t remove_key(
136
        _olm_curve25519_public_key const & public_key
137
    );
138
};
139

140

141
142
143
std::size_t pickle_length(
    Account const & value
);
144

145
146
147
148
149
150
151
152
153
154
155

std::uint8_t * pickle(
    std::uint8_t * pos,
    Account const & value
);


std::uint8_t const * unpickle(
    std::uint8_t const * pos, std::uint8_t const * end,
    Account & value
);
156
157


158
} // namespace olm
159

160
#endif /* OLM_ACCOUNT_HH_ */