File: util.md

package info (click to toggle)
oscrypto 1.3.0-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,164 kB
  • sloc: python: 22,115; makefile: 7
file content (45 lines) | stat: -rw-r--r-- 1,109 bytes parent folder | download | duplicates (2)
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
# oscrypto.util API Documentation

The *oscrypto.util* submodule implements supporting cryptographic functionality.
The following functions comprise the public API:

 - [`rand_bytes()`](#rand_bytes-function)
 - [`constant_compare()`](#constant_compare-function)

### `rand_bytes()` function

> ```python
> def rand_bytes(length):
>     """
>     :param length:
>         The desired number of bytes
>
>     :raises:
>         ValueError - when any of the parameters contain an invalid value
>         TypeError - when any of the parameters are of the wrong type
>         OSError - when an error is returned by the OS crypto library
>
>     :return:
>         A byte string
>     """
> ```
>
> Returns a number of random bytes suitable for cryptographic purposes

### `constant_compare()` function

> ```python
> def constant_compare(a, b):
>     """
>     :param a:
>         The first byte string
>
>     :param b:
>         The second byte string
>
>     :return:
>         A boolean if the two byte strings are equal
>     """
> ```
>
> Compares two byte strings in constant time to see if they are equal