account.hh 5.27 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
19
20
#include "olm/list.hh"
#include "olm/crypto.hh"
#include "olm/error.hh"
21
22
23

#include <cstdint>

24
namespace olm {
25
26


27
28
29
30
31
32
struct IdentityKeys {
    Ed25519KeyPair ed25519_key;
    Curve25519KeyPair curve25519_key;
};

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


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
    ErrorCode 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
59
60
61
62
63
64
65
66
    /** Number of bytes needed to output the identity keys for this account */
    std::size_t get_identity_json_length(
        std::size_t user_id_length,
        std::size_t device_id_length,
        std::uint64_t valid_after_ts,
        std::uint64_t valid_until_ts
    );

    /** Output the identity keys for this account as JSON in the following
67
     * format:
68
     *
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
     *    {"algorithms":
     *    ["m.olm.curve25519-aes-sha256"
     *    ]
     *    ,"device_id":"<device identifier>"
     *    ,"keys":
     *    {"curve25519:<key id>":"<base64 characters>"
     *    ,"ed25519:<key id>":"<base64 characters>"
     *    }
     *    ,"user_id":"<user identifier>"
     *    ,"valid_after_ts":<digits>
     *    ,"valid_until_ts":<digits>
     *    ,"signatures":
     *    {"<user identifier>/<device identifier>":
     *    {"ed25519:<key id>":"<base64 characters>"
     *    }
     *    }
     *    }
     *
     * The user_id and device_id must not contain 0x00-0x1F, '\"' or '\\'.
     * The JSON up to but not including the "signatures" key will be signed
     * using the account's ed25519 key. That signature is then included under
     * the "signatures" key.
91
92
93
     *
     * 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. */
94
95
96
97
98
    std::size_t get_identity_json(
        std::uint8_t const * user_id, std::size_t user_id_length,
        std::uint8_t const * device_id, std::size_t device_id_length,
        std::uint64_t valid_after_ts,
        std::uint64_t valid_until_ts,
99
        std::uint8_t * identity_json, std::size_t identity_json_length
100
101
    );

102
103
104
    /** Number of bytes needed to output the one time keys for this account */
    std::size_t get_one_time_keys_json_length();

105
106
107
108
109
110
111
    /** Output the one time keys that haven't been published yet as JSON:
     *
     *  {"curve25519:<key id>":"<base64 characters>"
     *  ,"curve25519:<key_id>":"<base64 characters>"
     *  ...
     *  }
     *
112
113
114
115
116
117
118
     * 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
    );

119
120
121
122
123
124
125
    /** 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();

126
127
    /** The number of random bytes needed to generate a given number of new one
     * time keys. */
128
129
130
131
132
133
134
135
136
137
138
139
140
    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
    );

141
    /** Lookup a one time key with the given public key */
142
    OneTimeKey const * lookup_key(
143
        Curve25519PublicKey const & public_key
144
    );
145

146
    /** Remove a one time key with the given public key */
147
    std::size_t remove_key(
148
        Curve25519PublicKey const & public_key
149
    );
150
};
151

152

153
154
155
std::size_t pickle_length(
    Account const & value
);
156

157
158
159
160
161
162
163
164
165
166
167

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
);
168
169


170
} // namespace olm
171

172
#endif /* OLM_ACCOUNT_HH_ */