You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-1Lines changed: 54 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,64 @@ The encryption and decryption operation are exposed using REST APIs(The usage is
16
16
## Dependencies
17
17
1.[gorilla-mux](https://github.com/gorilla/mux): A powerful HTTP router and URL matcher for building Go web servers with
18
18
19
+
<br>
20
+
21
+
## Configurations
22
+
The application uses two ```json``` configuration files and one ```.txt```.
23
+
1. des_input.txt - Contains the inputs or properties of the Simplified-DES algorithm. The file looks like this:
24
+
```
25
+
key:0010010111
26
+
P10:3 5 2 7 4 10 1 9 8 6
27
+
P8:6 3 7 4 8 5 10 9
28
+
P4:2 4 3 1
29
+
IP:2 6 3 1 4 8 5 7
30
+
IP-1:4 1 3 5 7 2 8 6
31
+
E/P:4 1 2 3 2 3 4 1
32
+
S0:1 0 3 2 3 2 1 0 0 2 1 3 3 1 3 2
33
+
S1:0 1 2 3 2 0 1 3 3 0 1 0 2 1 0 3
34
+
```
35
+
The file contains colon ```:``` separated key pair values. Following is the brief description of properties:
36
+
```
37
+
i. P10 - ten-length permutation of the algorithm. Ten space separated integers denoting the permutation.
38
+
ii. P8 - eight-length permutation of the algorithm. Eight space separated integers denoting the permutation.
39
+
iii. P4 - four-length permutation of the algorithm. Four space separated integers denoting the permutation.
40
+
iv. IP - initial permutation of the algorithm. Eight space separated integers denoting the permutation.
41
+
v. IP-1 - inverse permutation of the algorithm. Eight space separated integers denoting the permutation.
42
+
vi. E/P - expansion permutation of the algorithm. Eight space separated integers denoting the permutation.
43
+
vii. S0 - s0 matrix of the algorithm. Sixteen space separated integers denoting the permutation.
44
+
viii. S1 - s1 matrix of the algorithm. Sixteen space separated integers denoting the permutation.
45
+
ix. key - cipher key of the algorithm. Ten-length binary string.
46
+
```
47
+
48
+
2. des_config.json: Input values are provided as json attribute.
49
+
```json
50
+
{
51
+
"fastmode": true,
52
+
"threadcount": 8,
53
+
"buffersize": 1048576
54
+
}
55
+
```
56
+
fastmode - boolean attribute. If set to true, then encryption of a file will be done multithreaded manner.
57
+
threadcount - Integer attribute. Defines how many buffers will be encrypted concurrently at a time.
58
+
buffersize - Integer attribute. Defines the size of the buffer in bytes which will be read from file, encrypted and written back to disk. Default value is ```1048576``` i.e 1 MB.
59
+
60
+
3. config.json - Defines the configurations of the application server.
61
+
```
62
+
{
63
+
"name": "FES App Server",
64
+
"port": 8080,
65
+
"protocol": "HTTP"
66
+
}
67
+
```
68
+
name - Name of the application
69
+
port - port on which app server listens for request.
70
+
protocol - name of the protocol used by the server.
71
+
19
72
## Want to contribute
20
73
1. Explain the issue that must be fixed or a feature that must to be added.
21
74
2. Fork the repository to your github account.
22
75
3. Make your changes.
23
-
4. Create a pull request Lm your forked repository to master branch of this repository
76
+
4. Create a pull request from your forked repository to master branch of this repository
24
77
25
78
## License
26
79
This project is licensed under GNU GPL v3 license.
0 commit comments