Reference
Note
xor_cipher.python
contains pure-python implementations,
while xor_cipher.core
uses extensions. Usually imports should happen from xor_cipher
,
which will use the fastest available functionality.
xor(data: bytes, key: int) -> bytes
Applies XOR operation (byte ^ key
) for each byte
in data
.
This function is its own inverse, meaning
xor(xor(data, key), key) == data
for any data
and key
.
Parameters:
Raises:
Type | Description |
---|---|
ValueError
|
If the |
Returns:
Type | Description |
---|---|
bytes
|
The encoded data. |
Source code in src/xor_cipher/python.py
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 |
|
cyclic_xor(data: bytes, key: bytes) -> bytes
Applies XOR operation (byte ^ key_byte
) for each byte
in data
and key_byte
in key
, which is cycled to fit the length of the data
.
This function is its own inverse, meaning
cyclic_xor(cyclic_xor(data, key), key) == data
for any data
and key
.
Parameters:
Returns:
Type | Description |
---|---|
bytes
|
The encoded data. |
Source code in src/xor_cipher/python.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
|
xor_in_place(data: bytearray, key: int) -> None
Similar to xor
, except it operates in-place.
Parameters:
Raises:
Type | Description |
---|---|
ValueError
|
If the |
Source code in src/xor_cipher/python.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
|
cyclic_xor_in_place(data: bytearray, key: bytes) -> None
Similar to cyclic_xor
, except it operates in-place.
Parameters:
Source code in src/xor_cipher/python.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
|
MIN_BYTE: Literal[0] = 0
module-attribute
The minimum byte value.
MAX_BYTE: Literal[255] = 255
module-attribute
The maximum byte value.
expect_byte(value: int) -> int
Ensures the int
value provided is in [0, 255]
range.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value
|
int
|
The value to check. |
required |
Raises:
Type | Description |
---|---|
ValueError
|
If the given value is outside the expected range. |
Source code in src/xor_cipher/bytes.py
18 19 20 21 22 23 24 25 26 27 28 29 30 |
|