altcha-server/README.md

Altcha server

Serveur de génération de challenges altcha et de validation de la solution

Utilisation

Lancer le serveur

Depuis le binaire

$ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/altcha run

Depuis l'image docker

$ docker run -e ALTCHA_HMAC_KEY="CLÉ HMAC" -p 3333:3333 reg.cadoles.com/cadoles/altcha

Depuis les sources

$ ALTCHA_HMAC_KEY="CLÉ HMAC" go run ./cmd/altcha run

Une fois le serveur lancé, se rendre sur localhost:3333/request pour effectuer une demande de challenge. Publier la solution sur localhost:3333/verify ou localhost:3333/verify-spam-filter

Les détails sur le fonctionnement sont à retrouver sur la documentation d'altcha : https://altcha.org/fr/docs/get-started/

Autres commandes

Générer un challenge

$ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/altcha generate

Résoudre un challenge

$ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/atlcha solve [CHALLENGE] [SALT]

Vérifier une solution

$ ALTCHA_HMAC_KEY="CLÉ HMAC" bin/altcha verify [CHALLENGE] [SALT] [SIGNATURE] [SOLUTION]

Variables d'environement

Nom	Description	Valeur par défaut	Requis
ALTCHA_BASE_URL	Url de base du service		Non
ALTCHA_PORT	Port d'écoute du serveur	3333	Non
ALTCHA_HMAC_KEY	Clé d'encodage des signatures		Oui
ALTCHA_MAX_NUMBER	Nombre d'itération maximum pour résoudre le challenge (défini la difficulté)	1000000	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_EXPIRE	Temps avant expiration du challenge (en secondes)	600	Non
ALTCHA_CHECK_EXPIRE	Vérifier si le challenge à expiré	1	Non

Construire le binaire

$ make build

Construire l'image docker

$ make build-image

Publier l'image docker

$ make release-image