Cadoles
/
altcha-server
21
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Maj readme

This commit is contained in:
Valentin Carroy 2024-09-11 10:12:39 +02:00
parent 25a5368a26
commit b6c26a2285
1 changed files with 47 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -2,14 +2,40 @@
Serveur de génération de challenges altcha et de validation de la solution Serveur de génération de challenges altcha et de validation de la solution
# Utilisation ## Utilisation
Lancer le serveur ### Depuis le binaire
``` ```sh
altcha run $ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/altcha run
``` ```
# Variables d'environement ### Depuis l'image docker
```sh
$ docker run -e ALTCHA_HMAC_KEY="CLÉ HMAC" reg.cadoles.com/cadoles/altcha
```
### Depuis les sources
```sh
$ ALTCHA_HMAC_KEY="CLÉ HMAC" go run ./cmd/altcha run
```
### Autres commandes
Générer un challenge
```sh
$ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/altcha generate
```
Résoudre un challenge
```sh
$ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/atlcha solve [CHALLENGE] [SALT]
```
Vérifier une solution
```sh
$ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/altcha verify [CHALLENGE] [SALT] [SIGNATURE] [SOLUTION]
```
## Variables d'environement
| Nom | Description | Valeur par défaut | Requis | | Nom | Description | Valeur par défaut | Requis |
|---------------------|------------------------------------------------------------------------------|--------------------------|--------| |---------------------|------------------------------------------------------------------------------|--------------------------|--------|
| ALTCHA_PORT | Port d'écoute du serveur | 3333 | Non | | ALTCHA_PORT | Port d'écoute du serveur | 3333 | Non |
@ -18,4 +44,19 @@ altcha run
| ALTCHA_ALGORITHM | Algorithme de hashage (valeurs possibles: SHA-1, SHA-256, SHA-512) | SHA-256 | Non | | ALTCHA_ALGORITHM | Algorithme de hashage (valeurs possibles: SHA-1, SHA-256, SHA-512) | SHA-256 | Non |
| ALTCHA_SALT | Forcer le salt du challenge | *Généré automatiquement* | Non | | ALTCHA_SALT | Forcer le salt du challenge | *Généré automatiquement* | Non |
| ALTCHA_EXPIRE | Temps avant expiration du challenge (en secondes) | 600 | Non | | ALTCHA_EXPIRE | Temps avant expiration du challenge (en secondes) | 600 | Non |
| ALTCHA_CHECK_EXPIRE | Vérifier si le challenge à expiré | 1 | Non | | ALTCHA_CHECK_EXPIRE | Vérifier si le challenge à expiré | 1 | Non |
## Construire le binaire
```sh
$ make build
```
## Construire l'image docker
```sh
$ make build-image
```
## Publier l'image docker
```sh
$ make release-image
```