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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
# Copyright 2013-2018 Donald Stufft and individual contributors
#
# 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.
import binascii
import json
import os
import random
from typing import ByteString, List, Optional, Tuple
from _pytest._code import ExceptionInfo
from _pytest.monkeypatch import MonkeyPatch
import pytest
from nacl._sodium import ffi
from nacl.bindings.crypto_secretstream import (
crypto_secretstream_xchacha20poly1305_ABYTES,
crypto_secretstream_xchacha20poly1305_HEADERBYTES,
crypto_secretstream_xchacha20poly1305_KEYBYTES,
crypto_secretstream_xchacha20poly1305_STATEBYTES,
crypto_secretstream_xchacha20poly1305_TAG_FINAL,
crypto_secretstream_xchacha20poly1305_TAG_MESSAGE,
crypto_secretstream_xchacha20poly1305_TAG_PUSH,
crypto_secretstream_xchacha20poly1305_TAG_REKEY,
crypto_secretstream_xchacha20poly1305_init_pull,
crypto_secretstream_xchacha20poly1305_init_push,
crypto_secretstream_xchacha20poly1305_keygen,
crypto_secretstream_xchacha20poly1305_pull,
crypto_secretstream_xchacha20poly1305_push,
crypto_secretstream_xchacha20poly1305_rekey,
crypto_secretstream_xchacha20poly1305_state,
)
from nacl.utils import random as randombytes
Chunk = Tuple[int, Optional[bytes], bytes, bytes]
def read_secretstream_vectors() -> List[Tuple[bytes, bytes, List[Chunk]]]:
DATA = "secretstream-test-vectors.json"
path = os.path.join(os.path.dirname(__file__), "data", DATA)
with open(path) as fp:
jvectors = json.load(fp)
unhex = binascii.unhexlify
vectors = [
(
unhex(v["key"]),
unhex(v["header"]),
[
(
c["tag"],
unhex(c["ad"]) if c["ad"] is not None else None,
unhex(c["message"]),
unhex(c["ciphertext"]),
)
for c in v["chunks"]
],
)
for v in jvectors
]
return vectors
@pytest.mark.parametrize(
("key", "header", "chunks"),
read_secretstream_vectors(),
)
def test_vectors(key: bytes, header: bytes, chunks: List[Chunk]):
state = crypto_secretstream_xchacha20poly1305_state()
crypto_secretstream_xchacha20poly1305_init_pull(state, header, key)
for tag, ad, message, ciphertext in chunks:
m, t = crypto_secretstream_xchacha20poly1305_pull(
state, ciphertext, ad
)
assert m == message
assert t == tag
def test_it_like_libsodium():
ad_len = random.randint(1, 100)
m1_len = random.randint(1, 1000)
m2_len = random.randint(1, 1000)
m3_len = random.randint(1, 1000)
ad = randombytes(ad_len)
m1 = randombytes(m1_len)
m2 = randombytes(m2_len)
m3 = randombytes(m3_len)
m1_ = m1[:]
m2_ = m2[:]
m3_ = m3[:]
state = crypto_secretstream_xchacha20poly1305_state()
k = crypto_secretstream_xchacha20poly1305_keygen()
assert len(k) == crypto_secretstream_xchacha20poly1305_KEYBYTES
# push
assert (
len(state.statebuf) == crypto_secretstream_xchacha20poly1305_STATEBYTES
)
header = crypto_secretstream_xchacha20poly1305_init_push(state, k)
assert len(header) == crypto_secretstream_xchacha20poly1305_HEADERBYTES
c1 = crypto_secretstream_xchacha20poly1305_push(state, m1)
assert len(c1) == m1_len + crypto_secretstream_xchacha20poly1305_ABYTES
c2 = crypto_secretstream_xchacha20poly1305_push(state, m2, ad)
assert len(c2) == m2_len + crypto_secretstream_xchacha20poly1305_ABYTES
c3 = crypto_secretstream_xchacha20poly1305_push(
state, m3, ad=ad, tag=crypto_secretstream_xchacha20poly1305_TAG_FINAL
)
assert len(c3) == m3_len + crypto_secretstream_xchacha20poly1305_ABYTES
# pull
crypto_secretstream_xchacha20poly1305_init_pull(state, header, k)
m1, tag = crypto_secretstream_xchacha20poly1305_pull(state, c1)
assert tag == crypto_secretstream_xchacha20poly1305_TAG_MESSAGE
assert m1 == m1_
m2, tag = crypto_secretstream_xchacha20poly1305_pull(state, c2, ad)
assert tag == crypto_secretstream_xchacha20poly1305_TAG_MESSAGE
assert m2 == m2_
# Mark this as taking a generic Exception, or else mypy will later complain
# that we can't write an ExceptionInfo[ValueError] value to an expression of type
# ExceptionInfo[RuntimeError].
excinfo: ExceptionInfo[Exception]
with pytest.raises(RuntimeError) as excinfo:
crypto_secretstream_xchacha20poly1305_pull(state, c3)
assert str(excinfo.value) == "Unexpected failure"
m3, tag = crypto_secretstream_xchacha20poly1305_pull(state, c3, ad)
assert tag == crypto_secretstream_xchacha20poly1305_TAG_FINAL
assert m3 == m3_
# previous with FINAL tag
with pytest.raises(RuntimeError) as excinfo:
crypto_secretstream_xchacha20poly1305_pull(state, c3, ad)
assert str(excinfo.value) == "Unexpected failure"
# previous without a tag
with pytest.raises(RuntimeError) as excinfo:
crypto_secretstream_xchacha20poly1305_pull(state, c2, None)
assert str(excinfo.value) == "Unexpected failure"
# short ciphertext
with pytest.raises(ValueError) as excinfo:
c2len = random.randint(
1, crypto_secretstream_xchacha20poly1305_ABYTES - 1
)
crypto_secretstream_xchacha20poly1305_pull(state, c2[:c2len])
assert str(excinfo.value) == "Ciphertext is too short"
with pytest.raises(ValueError) as excinfo:
crypto_secretstream_xchacha20poly1305_pull(state, b"")
assert str(excinfo.value) == "Ciphertext is too short"
# empty ciphertext
with pytest.raises(ValueError) as excinfo:
crypto_secretstream_xchacha20poly1305_pull(
state,
c2[: crypto_secretstream_xchacha20poly1305_ABYTES - 1],
None,
)
assert str(excinfo.value) == "Ciphertext is too short"
# without explicit rekeying
header = crypto_secretstream_xchacha20poly1305_init_push(state, k)
c1 = crypto_secretstream_xchacha20poly1305_push(state, m1)
c2 = crypto_secretstream_xchacha20poly1305_push(state, m2)
crypto_secretstream_xchacha20poly1305_init_pull(state, header, k)
m1, tag = crypto_secretstream_xchacha20poly1305_pull(state, c1)
assert m1 == m1_
m2, tag = crypto_secretstream_xchacha20poly1305_pull(state, c2)
assert m2 == m2_
# with explicit rekeying
header = crypto_secretstream_xchacha20poly1305_init_push(state, k)
c1 = crypto_secretstream_xchacha20poly1305_push(state, m1)
crypto_secretstream_xchacha20poly1305_rekey(state)
c2 = crypto_secretstream_xchacha20poly1305_push(state, m2)
crypto_secretstream_xchacha20poly1305_init_pull(state, header, k)
m1, tag = crypto_secretstream_xchacha20poly1305_pull(state, c1)
assert m1 == m1_
with pytest.raises(RuntimeError):
crypto_secretstream_xchacha20poly1305_pull(state, c2)
crypto_secretstream_xchacha20poly1305_rekey(state)
m2, tag = crypto_secretstream_xchacha20poly1305_pull(state, c2)
assert m2 == m2_
# with explicit rekeying using TAG_REKEY
header = crypto_secretstream_xchacha20poly1305_init_push(state, k)
state_save: ByteString = ffi.buffer(state.statebuf)[:]
c1 = crypto_secretstream_xchacha20poly1305_push(
state, m1, tag=crypto_secretstream_xchacha20poly1305_TAG_REKEY
)
c2 = crypto_secretstream_xchacha20poly1305_push(state, m2)
csave = c2[:]
crypto_secretstream_xchacha20poly1305_init_pull(state, header, k)
m1, tag = crypto_secretstream_xchacha20poly1305_pull(state, c1)
assert m1 == m1_
assert tag == crypto_secretstream_xchacha20poly1305_TAG_REKEY
m2, tag = crypto_secretstream_xchacha20poly1305_pull(state, c2)
assert m2 == m2_
assert tag == crypto_secretstream_xchacha20poly1305_TAG_MESSAGE
# avoid using from_buffer until at least cffi >= 1.10 in setup.py
# state = ffi.from_buffer(state_save)
for i in range(crypto_secretstream_xchacha20poly1305_STATEBYTES):
# Type safety: we can't write to a `ByteString` (≈ `Sequence[int]`). It's really
# a CFFI `cdata` object which owns an `unsigned char[]` (which we can write to).
# This is the only place we mutate `state_buf` in place across the project,
# and we don't expect end-users to do this.
state.statebuf[i] = state_save[i] # type: ignore[index]
c1 = crypto_secretstream_xchacha20poly1305_push(state, m1)
c2 = crypto_secretstream_xchacha20poly1305_push(state, m2)
assert csave != c2
# New stream
header = crypto_secretstream_xchacha20poly1305_init_push(state, k)
c1 = crypto_secretstream_xchacha20poly1305_push(
state, m1, tag=crypto_secretstream_xchacha20poly1305_TAG_PUSH
)
assert len(c1) == m1_len + crypto_secretstream_xchacha20poly1305_ABYTES
# snip tests that require introspection into the state buffer
# to test the nonce as we're using an opaque pointer
def test_max_message_size(monkeypatch: MonkeyPatch):
import nacl.bindings.crypto_secretstream as css
# we want to create an oversized message but don't want to blow out
# memory so knock it down a bit for this test
monkeypatch.setattr(
css,
"crypto_secretstream_xchacha20poly1305_MESSAGEBYTES_MAX",
2 ** 10 - 1,
)
m = b"0" * (css.crypto_secretstream_xchacha20poly1305_MESSAGEBYTES_MAX + 1)
k = crypto_secretstream_xchacha20poly1305_keygen()
state = crypto_secretstream_xchacha20poly1305_state()
crypto_secretstream_xchacha20poly1305_init_push(state, k)
with pytest.raises(ValueError) as excinfo:
crypto_secretstream_xchacha20poly1305_push(state, m, None, 0)
assert str(excinfo.value) == "Message is too long"
|