Skip to content

Commit 45fee7c

Browse files
author
Hamza ESSAYEGH
committed
Update key generation documentation
1 parent 9c6aa7c commit 45fee7c

1 file changed

Lines changed: 2 additions & 12 deletions

File tree

Resources/doc/key_generation_proc.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Author: Hamza ESSAYEGH <querdos>
33
## Using the console
44
If you want to generate a key pair manually in the console, a command is available:
55
```bash
6-
$ bin/console qfe:gen-key [options]
6+
bin/console qfe:gen-key [options]
77
```
88

99
There are three mandatory options :
@@ -13,7 +13,7 @@ There are three mandatory options :
1313

1414
Example:
1515
```bash
16-
$ bin/console qfe:gen-key -u querdos -r querdos@gmail.com -p dumbPassphrase
16+
bin/console qfe:gen-key -u querdos -r querdos@gmail.com -p dumbPassphrase
1717
```
1818

1919
Suposing you haven't changed the default `gnupg_home`, it will create a directory `username` and store the generated key
@@ -69,13 +69,3 @@ Suppose you have a form that submit the generation demand:
6969
}
7070
}
7171
```
72-
## Exceptions
73-
If you want to handle efficiently exception for your application, there are the main exceptions that can be thrown
74-
with the key pair generation:
75-
* `KeyOptionException` is thrown when a specified option don't pass the tests for GnuPG. For example a malformed
76-
recipient, no username specified, etc...
77-
* `KeyGenerationException` is thrown when the key generation has failed for other problem than the specified options.
78-
To know why the generation has failed, you can refer to the generated `qfe_error.log` in the logs folder (specified in
79-
the `config.yml` file in the installation procedure)
80-
* `KeyImportExcemtion` is thrown when the trust database creation has failed (when trying to import the public and private
81-
key). Again, for more details about the error, please refer to your `qfe_error.log` file.

0 commit comments

Comments
 (0)