genrs 0.1.1

command-line tool and Library for generating random keys
Documentation 
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

# genrs

`genrs` is a command-line tool for generating random keys, UUIDs, and encoding them in different formats. It supports generating custom-length keys, common key presets, and UUIDs of various versions.

## Usage

To use `genrs`, run the following command:

```sh
genrs [OPTIONS]
```

## Options

### Key Generation Mode (default)

- `-p`, `--preset <PRESET>`
  - Specifies a preset for commonly used keys.
  - Possible values: `aes128`, `aes192`, `aes256`, `hmac256`, `hmac512`, `jwt256`, `jwt512`, `apikey128`, `apikey256`
  - Example: `genrs --preset aes256`

- `-f`, `--format <FORMAT>`
  - Specifies the encoding format for the generated key.
  - Possible values: `hex`, `base64`
  - Default: `hex`

- `-l`, `--length <LENGTH>`
  - Specifies the length of the generated key in bytes.
  - Default: `32` (i.e., 256 bits)
  - Ignored if a preset is used.

### UUID Generation Mode

- `-m`, `--mode <MODE>`
  - Specifies the mode: `key` for key generation, `uuid` for UUID generation.
  - Default: `key`

- `-u`, `--uuid-version <UUID_VERSION>`
  - Specifies the UUID version.
  - Possible values: `v1`, `v3`, `v4`, `v5`
  - Default: `v4`

- `-n`, `--namespace <NAMESPACE>`
  - Specifies the namespace UUID for UUID V3 or V5.

- `-N`, `--name <NAME>`
  - Specifies the name for UUID V3 or V5.

### General Options

- `-h`, `--help`
  - Print help information about `genrs`.

- `-V`, `--version`
  - Print the version of `genrs`.

## Examples

### Key Generation

Generate a 32-byte key in hexadecimal format (default):

```sh
genrs
```

Generate a 64-byte key in base64 format:

```sh
genrs -f base64 -l 64
```

Generate a 16-byte key using the `aes128` preset:

```sh
genrs --preset aes128
```

### UUID Generation

Generate a version 4 UUID:

```sh
genrs --mode uuid
```

Generate a version 1 UUID:

```sh
genrs --mode uuid --uuid-version v1
```

Generate a version 3 UUID with a namespace and name:

```sh
genrs --mode uuid --uuid-version v3 --namespace <UUID> --name "example"
```

## Installation

To install `genrs`, you can build it from source using Cargo:

```sh
cargo build --release
```

The resulting binary will be located in the `target/release` directory.
You can move it to a directory in your `PATH` for easy access.

## License

`genrs` is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.