translate Readme

# Analyse statistique d'une liste de mots de passe

# Statistical analysis of a password list

```shell

git clone https://git.unicaen.fr/passwords/cpack

```

## Requiert

Une liste de mots de passe sous forme d'un fichier .txt, et au format UTF-8.

Pour convertir un fichier .txt au format UTF-8, utilisez la commande suivante :

## Requirements

A password list, encoded in UTF-8.

To convert a file to UTF-8, use the following command:

```shell

iconv -f ISO-8859-1 -t UTF-8 input.txt -o output.txt

```

## Programme version console

Pour analyser une liste de mot de passe, effectuez les commandes suivantes :

## Installation

```shell

cd Statsgen

make cpack

./cpack liste.txt

git clone https://git.unicaen.fr/passwords/cppack

cd cppack

make cppack

```

Plusieurs options sont disponibles :

 * --help, -h

 * --withcount, -w     : préciser que la liste est au format "withcount" (i.e. [nombre d'occurences] [mot de passe])

 * --hiderare, -hr     : cacher les statistiques inférieures à 1%

 * --top, -t [value]   : montrer que les [value] premiers résultats

 * --regex, -r [value] : montrer les résultats des mots de passe respectant l'expression régulière [value]

Options d'optimisation :

 * --limitadvancedmasks, -lam [value] : limiter la taille des masques avancées à [value], si taille>[value]: othermasks

 * --limitsimplemasks, -lsm [value]   : limiter la taille des masques simples à [value], si taille>[value]: othermasks

 * --parallel, -p [value] 	      : nombre de thread utilisables (1 par défaut)

## Usage

Règles de sécurité :

 * --security, -s : définir les règles de sécurités

Par défaut, les règles de sécurité sont les suivantes :

 * Taille minimale des mots de passe : 8

 * Minimum 1 minuscule, 1 majuscule, 1 chiffre

## Interface graphique

Une interface en QT est disponible pour une version simplifiée et visuelle des statistiques.

	--> Requiert la version de QT comprenant QtCharts (version 5 minimum)

	--> Programme développé en version 5.9.4

To analyze a password list, use:

```shell

cd Statsgen

make cpack-gui

./cpack-gui

Usage: ./cppack FILENAME [OPTIONS]

To be sure the database's format can be read, please use this command before:

	iconv -f ISO-8859-1 -t UTF-8 databaseInput.txt -o databaseOutput.txt

Use '-' for FILENAME to read from stdin

Options:

	--help, -h          Show this help message

	--withcount, -w     Mendatory if the input database has the following format : [number of occurence] [password]

	--hiderare, -H      Hide all statistics below 1%

	--top, -t [value]   Show only [value] first results

	--regex, -r [value] Show result for password, using the regular expression [value]

	--out, -o [value]   Writes masks into [value] file

	--debug, -d         Enable debug printing

Optimisation options to reduce the execution time : 

	--limit-advanced-masks, -A [value]  Limit the size of the advanced masks at [value], if size>[value]: othermasks

	--limit-simple-masks, -S [value]    Limit the size of the simple masks at [value], if size>[value]: othermasks

	--parallel, -p [value]              Number of usable threads

Security rules: 

	--security, -s		Define the security rules

```

## Fonctions utilitaires

## Graphical Interface

Dans le dossier Utils, trois programmes ont été créées

 * convert.cpp : permet de créer une liste de mots de passe à partir d'une liste au format withcount

 * createNewDB.cpp : permet de créer des listes de mots de passe plus ou moins grandes, utile pour nos tests

 * memory.sh : permet de connaître la mémoire vive utilisée pour un certain processus

A QT GUI is available to have visual feedback of statistics.

To compile, it requires QtCharts version > 5 (available in Ubuntu repo since 18.04). This GUI has been developed using Qt 5.9.4.

Then run:

```shell

make cppack-gui

./cppack-gui

```

## License

Voir [LICENSE](LICENSE) pour plus de détails.

See [LICENSE](LICENSE) for licensing details.