File: hashrat.1

package info (click to toggle)
hashrat 1.10.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,984 kB
  • sloc: ansic: 21,832; sh: 369; makefile: 187
file content (648 lines) | stat: -rw-r--r-- 22,149 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
.TH hashrat "1" "Jan 2015" "HASHRAT 1.5" "hashing tool supporting several hashes and recursivity"
.\"Text automatically generated by txt2man
.SH NAME
\fBhashrat \fP- hashing tool supporting several hashes and recursivity
\fB
.SH SYNOPSIS
.nf
.fam C
\fBhashrat\fP [\fIoptions\fP] [\fIpaths\fP to \fIhash\fP]

\fBhashrat\fP \fB-c\fP [\fIoptions\fP] [\fIinput\fP \fIfile\fP of \fIhashes\fP]

.fam T
.fi
.SH DESCRIPTION
Hashrat is a \fIhash\fP-generation utility that supports the md5, sha1, sha256, sha512, whirlpool, jh-224, jh256, jh-384 and jh-512 \fIhash\fP functions, and
also the HMAC versions of those functions. It can output in traditional format (same as md5sum and shasum and the like) or it's own format.
.PP
Hashes can be output in octal, decimal, hexadecimal, uppercase hexadecimal or base64.
.PP
Hashrat also supports directory recursion, hashing entire devices, and generating a \fIhash\fP for an entire directory. It has a CGI mode that can
be used as a web-page to lookup \fIhashes\fP.
.SH OPTIONS
.TP
.B
-?, \fB-help\fP, \fB--help\fP
Print this help.
.TP
.B
\fB-version\fP, \fB--version\fP
Print program version.
.TP
.B
\fB-type <type>\fP
Use \fIhash\fP algorithm <type>. Hash types can be chained as a comma-seperated list.
.TP
.B
\fB-md5\fP
Use md5 \fIhash\fP algorithm. This is the default \fIhash\fP.
.TP
.B
\fB-sha1\fP
Use sha1 \fIhash\fP algorithm.
.TP
.B
\fB-sha256\fP
Use sha256 \fIhash\fP algorithm.
.TP
.B
\fB-sha512\fP
Use sha512 \fIhash\fP algorithm.
.TP
.B
\fB-whirl\fP
Use whirlpool \fIhash\fP algorithm.
.TP
.B
\fB-whirlpool\fP
Use whirlpool \fIhash\fP algorithm.
.TP
.B
\fB-jh224\fP
Use jh-224 \fIhash\fP algorithm.
.TP
.B
\fB-jh256\fP
Use jh-256 \fIhash\fP algorithm.
.TP
.B
\fB-jh384\fP
Use jh-384 \fIhash\fP algorithm.
.TP
.B
\fB-jh512\fP
Use jh-512 \fIhash\fP algorithm.
.TP
.B
\fB-hmac\fP
HMAC using specified \fIhash\fP algorithm.
.TP
.B
\fB-8\fP
Encode with octal instead of hex.
.TP
.B
\fB-10\fP
Encode with decimal instead of hex.
.TP
.B
\fB-H\fP, \fB-HEX\fP
Encode with UPPERCASE hexadecimal.
.TP
.B
\fB-64\fP, \fB-base64\fP
Encode with base64. 
.TP
.B
\fB-i64\fP, \fB-i64\fP
Encode with base64, with rearranged characters.
.TP
.B
\fB-p64\fP, \fB-p64\fP
Encode with base64 with a-z,A-Z and _-, for best compatibility with 'allowed characters' in websites.
.TP
.B
\fB-x64\fP, \fB-x64\fP
Encode with XXencode style base64.
.TP
.B
\fB-u64\fP, \fB-u64\fP
Encode with UUencode style base64.
.TP
.B
\fB-g64\fP, \fB-g64\fP
Encode with GEDCOM style base64.
.TP
.B
\fB-a85\fP, \fB-a85\fP
Encode with ASCII85.
.TP
.B
\fB-z85\fP, \fB-z85\fP
Encode with ZEROMQ variant of ASCII85.
\fB-t\fP, \fB-trad\fP
Output \fIhashes\fP in traditional md5sum, shaXsum format.
.TP
.B
\fB-tag\fP, \fB--tag\fP \fB-bsd\fP
Output \fIhashes\fP in bsdsum format.
.TP
.B
\fB-r\fP
Recurse into directories when hashing files.
.TP
.B
\fB-f\fP <listfile>
Hash files listed in <listfile>.
.TP
.B
\fB-i\fP <pattern>
Only \fIhash\fP items matching a comma-seperated list of shell patterns. Please be aware that -i does not yet work on directories, only files.
.TP
.B
\fB-x\fP <pattern>
Exclude items matching a comma-seperated list of shell patterns. Works on both directories and files.
.TP
.B
\fB-X\fP <path>
Exclude items listed in file <path>. Items in the file can be wildcards.
.TP
.B
\fB -name\fP  <pattern> 
Only hash items matching a comma-seperated list of shell patterns (-name as in the 'find' command).
.TP
.B
\fB -mtime\fP  <days> 
Only hash items <days> old. Has the same format as the find command, e.g. -10 is younger than ten days, +10 is older than ten, and 10 is ten days old.
.TP
.B
\fB -mmin\fP  <mins> 
Only hash items <min> minutes old. Has the same format as the find command, e.g. -10 is younger than ten mins, +10 is older than ten, and 10 is ten mins old.
.TP
.B
\fB -myear\fP  <years> 
Only hash items <years> old. Has the same format as the find command, e.g. -10 is younger than ten years, +10 is older than ten, and 10 is ten years old.
.TP
.B
\fB-exec\fP
In CHECK or MATCH mode only examine executable files.
.TP
.B
\fB-dups\fP
Search for duplicate files.
.TP
.B
\fB-n\fP <length>
Truncate \fIhashes\fP to <length> bytes.
.TP
.B
\fB-c\fP
CHECK \fIhashes\fP against list from \fIfile\fP (or stdin).
.TP
.B
\fB-cf\fP
CHECK \fIhashes\fP but only show failures.
.TP
.B
\fB-C <dir>\fP
CHECK \fIfiles\fP under dir recursively against a list from \fIfile\fP (or stdin). This can detect 'new' files
.TP
.B
\fB-Cf <dir>\fP
CHECK \fIfiles\fP under dir recursively against a list from \fIfile\fP (or stdin). This can detect 'new' files. Only show failures.
.TP
.B
\fB-m\fP
MATCH files from a list read from stdin.
.TP
.B
\fB-lm\fP
Read \fIhashes\fP from stdin, upload them to a memcached server (requires the \fB-memcached\fP option).
.TP
.B
\fB-memcached\fP <server>, \fB-mcd\fP <server>
Specify memcached server. This option overrides reading list from stdin if used with \fB-m\fP, \fB-c\fP or \fB-cf\fP.
.TP
.B
\fB-h\fP <script>
\fB-hook\fP <script>
Script to run when a \fIfile\fP fails CHECK mode, or is found in MATCH mode. Script is passed the filename as an argument. In 'find duplicates' mode a second file name (the duplicate) will be passed as the second argument.
.TP
.B
\fB-color\fP
Use ANSI color codes on output when checking \fIhashes\fP.
.TP
.B
\fB-S\fP, \fB-strict\fP
Strict mode: when checking, check \fIfile\fP mtime, owner, group, and inode as well as it's \fIhash\fP.
.TP
.B
\fB-d\fP
Dereference (follow) symlinks.
.TP
.B
\fB-fs\fP
Stay one filesystem.
.TP
.B
\fB-dir\fP
\fB-dirmode\fP
DirMode: read all files in directory and create one \fIhash\fP for them (implies -r).
.TP
.B
\fB-devmode\fP
DevMode: read from a \fIfile\fP EVEN OF IT'S A DEVNODE.
.TP
.B
\fB-lines\fP
Read lines from stdin and \fIhash\fP each line independently.
.TP
.B
\fB-rl\fP, \fB-rawlines\fP
Read lines from stdin and \fIhash\fP each line independently, INCLUDING any trailing whitespace. This is compatible with 'echo text | md5sum'.
.TP
.B
\fB-cgi\fP
Run in HTTP CGI mode.
.TP
.B
\fB-net\fP
Treat '\fIfile\fP' arguments as either ssh or http URLs, and pull files over the network and then \fIhash\fP them (allows hashing of files on remote machines).
URLs are in the format ssh://[username]:[password]@[host]:[port] or http://[username]:[password]@[host]:[port].
.TP
.B
\fB-idfile\fP <path>
Path to a ssh private key \fIfile\fP to use to authenticate INSTEAD OF A PASSWORD when pulling files via ssh.
.TP
.B
\fB-xattr\fP
Use eXtended \fIfile\fP ATTRibutes. In \fIhash\fP mode, store \fIhashes\fP in the \fIfile\fP attributes. In check mode compare against \fIhashes\fP stored in \fIfile\fP attributes.
.TP
.B
\fB-txattr\fP
Use TRUSTED eXtended \fIfile\fP ATTRibutes. In \fIhash\fP mode, store \fIhashes\fP in trusted \fIfile\fP attributes. The trusted attributes can only be read and written by root. Under FreeBSD this means 'SYSTEM' attributes.
.TP
.B
\fB-cache\fP
Use \fIhashes\fP stored in user xattr if they're younger than the mtime of the \fIfile\fP. This speeds up outputting \fIhashes\fP.
.TP
.B
\fB-u\fP <types>
Update. In checking mode, update \fIhashes\fP for the files as you go. The <types> is a comma-separated list of things to update, which can be xattr memcached
or a \fIfile\fP name. This will update these targets with the \fIhash\fP that was found at the time of checking.
.TP
.B
\fB-hide\fP-\fIinput\fP
When reading data from stdin in linemode, set the terminal to not echo characters, thus hiding typed \fIinput\fP.
.TP
.B
\fB-xsel\fP
Update X11 clipboard and primary selections to the current hash. This works using Xterm command sequences. The xterm resource 'allowWindowOps' must be set to 'true' for this to work.
.TP
.B
\fB-star\fP-\fIinput\fP
When reading data from stdin in linemode replace characters with stars.
.SH NOTES
Hashrat can also detect if it's being run under any of the following names (e.g., via symlinks):
.TP
.B
md5sum
Run with '\fB-trad\fP \fB-md5\fP'.
.TP
.B
shasum
Run with '\fB-trad\fP \fB-sha1\fP'.
.TP
.B
sha1sum
Run with '\fB-trad\fP \fB-sha1\fP'.
.TP
.B
sha256sum
Run with '\fB-trad\fP \fB-sha256\fP'.
.TP
.B
sha512sum
Run with '\fB-trad\fP \fB-sha512\fP'.
.TP
.B
jh224sum
Run with '\fB-trad\fP \fB-jh224\fP'.
.TP
.B
jh256sum
Run with '\fB-trad\fP \fB-jh256\fP'.
.TP
.B
jh384sum
Run with '\fB-trad\fP \fB-jh384\fP'.
.TP
.B
jh512sum
Run with '\fB-trad\fP \fB-jh512\fP'.
.TP
.B
whirlpoolsum
Run with '\fB-trad\fP \fB-whirl\fP'.
.TP
.B
hashrat.cgi
Run in web-enabled 'cgi mode'.
.SH EXAMPLES
.TP
.B
\fBhashrat\fP
Generate a md5 \fIhash\fP of data read from stdin  (default \fIhash\fP type is md5).
.TP
.B
\fBhashrat\fP \fB-jh256\fP
Generate a jh-256 \fIhash\fP of data read from stdin.
.TP
.B
\fBhashrat\fP \fB-sha256\fP \fB-64\fP
Generate a sha-256 \fIhash\fP of data read from stdin, output with base64 encoding.
.TP
.B
\fBhashrat\fP \fB-sha256\fP \fB-64\fP \fB-lines\fP
Read lines from stdin, and generate a sha-256 with base64 encoding FOR EVERY LINE. This strips any whitespace
from the end of the line (including \\r and/or \\n line terminators).
.TP
.B
\fBhashrat\fP \fB-md5\fP \fB-trad\fP \fB-rawlines\fP
Read lines from stdin, and generate a md5 \fIhash\fP in traditional format for every line INCLUDING TRAILING WHITESPACE.
This is compatible with 'echo text | md5sum', where text is one line, as echo adds a newline to the end of the
text it outputs.
.TP
.B
\fBhashrat\fP \fB-type sha256,whirl,md5\fP \fB-64\fP
Generate a sha-256 \fIhash\fP of data read from stdin, then hash the result with whirlpool, then with md5.
.TP
.B
\fBhashrat\fP *
Generate a list of \fIhashes\fP for files in the current directory (default \fIhash\fP type is md5).
.TP
.B
\fBhashrat\fP \fB-r\fP \fB-sha1\fP * > hashes.sha1
Generate a list of \fIhashes\fP for files in the current directory, AND ALL SUBDIRECTORIES, using sha1 hashing.
.TP
.B
cat hashes.sha1 > \fBhashrat\fP \fB-c\fP
Check \fIhashes\fP listed in hashes.sha1.
.TP
.B
cat hashes.sha1 > \fBhashrat\fP \fB-c\fP \fB-strict\fP
Check \fIhashes\fP listed in hashes.sha1. If \fIhashes\fP are NOT in traditional format than the \fB-strict\fP flag will cause
\fBhashrat\fP to check the files uid, gid, size, mtime and inode and print a failure message if any of those don't match.
.TP
.B
cat hashes.sha1 > \fBhashrat\fP \fB-cf\fP
Check \fIhashes\fP listed in hashes.sha1 but only output failures.
.TP
.B
cat APT1.md5 | \fBhashrat\fP \fB-m\fP \fB-r\fP /
Read a list of \fIhashes\fP from stdin and search recursively for files matching them.
.TP
.B
cat APT1.md5 | \fBhashrat\fP \fB-lm\fP \fB-memcached\fP 127.0.0.1
Read a list of \fIhashes\fP from stdin, and register them in a memcached server.
.TP
.B
\fBhashrat\fP \fB-m\fP \fB-memcached\fP 127.0.0.1 \fB-r\fP /
Search recursively for files whose \fIhashes\fP are stored in a memcached server.
.TP
.B
\fBhashrat\fP \fB-devmode\fP \fB-whirlpool\fP \fB-64\fP /dev/sda1
Generate a whirlpool \fIhash\fP of the entire device /dev/sda1. Output result in base 64.
.TP
.B
\fBhashrat\fP \fB-sha1\fP \fB-net\fP ssh:user:password@myhost/bin/*
Generate sha1 \fIhashes\fP of files in /bin/* on the remote machine 'myhost'.
.TP
.B
\fBhashrat\fP \fB-whirlpool\fP \fB-net\fP http://myhost.com/webpage.html
Generate whirlpool \fIhash\fP for the listed URL. Note, many webpages have dynamic content that changes
every time, so this will only return the same \fIhash\fP over and over if the page is static and doesn't change.
.TP
.B
\fBhashrat\fP \fB-dups\fP \fB-r\fP /home \fB-u\fP xattr
Search for duplicate files under /home. Update \fIhashes\fP stored in filesystem attributes as you go.
.SH USES FOR HASHRAT
.IP 1) 4
Strong Passwords
.PP
Hashrat can be used to generate strong passwords for websites. So, you don't have to remember the strong password, if it be always regenerate with \fBhashrat\fP.
You need to remember a handful of moderately decent passwords, i.e., things that I can't find by grepping in the '10,000 most popular passwords' list[1],
and an additional personal pin. Now, you need to combine the website name, one of passwords, and the personal pin, into a string and feed them into \fBhashrat\fP:
.PP
.nf
.fam C
    $ echo "facebook.com password 1234" | hashrat \-sha1 \-64

.fam T
.fi
Obviously, a good password isn't 'password' and a good pin isn't '1234', but you get the idea. This gives a 28-character string that should take "8.02 trillion
centuries" to crack with a "massive cracking array", according to Steve Gibson's Password haystacks utility[2]. This is what I then use as my password. Unfortunately
some websites won't take a 28-character password, and for these you can truncate to the appropriate length (using the \fB-n\fP flag), but the results are still stronger
than anything you could remember, and nothing needs storing on disk (as with password managers).
.PP
There are some dangers to using the 'echo' method shown above if you are on a shared machine, or if someone gets hold of your computer/harddrive. On a shared machine
someone could type 'ps ax' to see all commands running, and if they time it right, they might see your command-line with your password in it. Another danger lies in
using a shell (like bash) that will record your typed commands so you can recall them later. Bash stores this information on disk in the \fIfile\fP .bash_history, so if
you use the 'echo' method shown above your password will be saved on disk. To combat this \fBhashrat\fP has line mode:
.PP
.nf
.fam C
    $ hashrat \-sha1 \-64 \-lines

.fam T
.fi
This reads lines from stdin, so type into \fBhashrat\fP and then press ENTER, and you'll be given the \fIhash\fP of the line you typed. By this method your password is neither
visible in 'ps ax', nor is ever stored on disk.
.PP
A \fB-lines\fP will produce a different \fIhash\fP to the 'echo' method listed above, because it strips any trailing whiespace off the lines read. If you want strict compatibility
with 'echo' (by default echo adds a newline to the end of the text to output) then use rawlines mode:
.PP
.nf
.fam C
    $ hashrat \-sha1 \-64 \-rawlines

.fam T
.fi
Finally, you can prevent shoulder-surfers seeing you type your password by using the \fB-hide\fP-\fIinput\fP or \fB-star\fP-\fIinput\fP \fIoptions\fP to hide what you type.
.PP
.nf
.fam C
    [1] https://github.com/discourse/discourse/blob/master/lib/common_passwords/10k-common-passwords.txt

    [2] https://www.grc.com/haystack.htm

.fam T
.fi
.IP 2) 4
Watching for \fIfile\fP changes
.PP
Like md5sum/shasum etc, \fBhashrat\fP can be used to detect changes in files that might indicate malicious activity. For instance, in order to get early warning of malware
like cryptolocker (that encrypts files on a users disk, or on network shares, and then demands a ransom for \fIfile\fP recovery) you can scatter about the disk a number
of Canary files that should not change. You need record their \fIhashes\fP and regularly check them. If they change, you will know something is going on.
.PP
Hashes generated by \fBhashrat\fP can be output to a \fIfile\fP, or stored in extended \fIfile\fP attributes, or in a memcached server.
.PP
.nf
.fam C
    $ hashrat \-sha256 \-r . > /tmp/files.sha256

    $ hashrat \-sha256 \-r . \-xattr

    $ hashrat \-sha256 \-r . \-memcached

.fam T
.fi
Similarly these can then be used to check files later:
.PP
.nf
.fam C
    $ cat /tmp/files.sha256 | hashrat -c \-sha256

    $ hashrat \-C . \-sha256  \-xattr

    $ hashrat \-C /tmp \-sha256  \-memcached

.fam T
.fi
Note that -c checks only check the files in the supplied list. The -C flag instead checks all files in a directory (supplied on command line) and expects to find those in the list. This means that -C can find new files that aren't in the list, whereas -c can't.
.fi
There is a slight difference between xattr/memcached checks and checks where a list is read from stdin. Currently when reading from stdin \fBhashrat\fP will ONLY check the
files in the list. However, in \fB-xattr\fP and \fB-memcached\fP mode, it will check all files, outputting and error for those where no stored \fIhash\fP can be found. This is likely
to change in the a future release, with the stdin method being brought into line with the others.
.IP 3) 4
Finding files that match \fIhashes\fP
.PP
Using the \fB-m\fP flag \fBhashrat\fP can be told to read a range of \fIhashes\fP from stdin, and then search for files matching those \fIhashes\fP. For Example:
.PP
.nf
.fam C
    $ cat APT1-AppendixE-MD5s.txt | hashrat \-r \-m /usr

.fam T
.fi
The last command will search recursively under /usr for files with \fIhashes\fP matching those in APT1-AppendixE-MD5s.txt. The \fIinput\fP on stdin must begin with a \fIhash\fP, anything
written after the \fIhash\fP will be treated as a comment to be displayed if a \fIfile\fP matching the \fIhash\fP is found.
.PP
Hashtypes other than md5 can be used thusly:
.PP
.nf
.fam C
    $ cat sha1-list.lst | hashrat \-r \-sha1 \-m /usr

.fam T
.fi
Hashes can also be loaded into a memcached server, so that the same \fIfile\fP list can be checked on a number of machines, without needing to store the hashlist on those
machines. First you need load the \fIhashes\fP:
.PP
.nf
.fam C
    $ cat APT1-AppendixE-MD5s.txt | hashrat \-lm \-memcached 192.168.1.5

.fam T
.fi
The last line loads the \fIhashes\fP to a memcached server at 192.168.1.5. You can then search against the memcached server by:
.PP
.nf
.fam C
    $ hashrat \-r \-m \-memcached 192.168.1.5 /usr

.fam T
.fi
.IP 4) 4
Find duplicate files
.PP
Using the \fB-dups\fP flag (usually in combination with the \fB-r\fP recursive flag) \fBhashrat\fP can be set to search for duplicate files and output any found to stdout.

.SH HOOKSCRIPTS
.PP
  Hookscripts, defined using the \fB-h\fP or \fB-hook\fP command-line options, are scripts that are run for each hashed item. \fB-h\fP and \fB-hook\fP options take an argument that is the path to the script. Hookscripts behave differently in different modes:

.TP
\fBCheck Hashes\fP mode.
The hookscript is called if a file doesn't match it's expected hash, or is not listed in the expected hashes. It is passed the path of the file.
.TP
\fBLocate files\fP mode  
The hookscript is called if a file matches the hash to locate. It is passed the path of the file.
.TP
\fBFind duplicates\fP mode
The hookscript is called if a file is a duplicate of another file. It is passed the paths of both files.

.SH CGI Mode
.PP
If \fBhashrat\fP is run with the \fB-cgi\fP flag, or if it's run with a name of \fBhashrat.cgi\fP (either by renaming the \fBhashrat\fP executable, or via a symbolic link) it will output a webpage that allows users to look up \fIhashes\fP over the web. This allows one to look-up your strong passwords even if you don't have access to a local version of \fBhashrat\fP.
.PP
CGI Mode can be configured using an options file. The file path is passed in the url, like this:
.nf
.fam C
hashrat.cgi?OptionsFile=/etc/hashrat.options
.fam T
.fi

If an options file is used, then CGI mode uses the options in the file as its defaults. The options file contains the following :
.TP
HashType <type>      Type of hash to generate
.TP
Encoding <type>      Type of encoding to use for outputted hash
.TP
Line Ending <type>   Line ending to append to input text. This is for compatibility with command-line usage with "-rawlines". Options are "none", "lf", "crlf" or "cr", meaning "none", "newline", "carriage-return newline" and "carriage-return" respectively.
.TP
OutputLength <len>   Crop output hash to length len "len"
.TP
SegmentLength <len>  Break output up into segments of length "len"
.TP
SegmentChar <char>   Separate output segments with character "char"
.TP
NoOptions            Do not offer the user the options so they can change them. Just show an entry box to enter text.
.TP
HideText             Hide inputted text (overrides any other config)
.TP
ShowText             Show inputted text (overrides any other config)
.PP
.TP
Example:
.nf
.fam C
HashType=sha256
Encoding=base64
LineEnding=none
OutputLength=12
SegmentLength=4
SegmentChar=+
NoOptions=Y
.fam T
.fi

.SH EXTENDED FILESYSTEM ATTRIBUTES

Hashrat can use extended filesystem attributes where these are supported. This allows a \fIhash\fP to be stored in the filesystem metadata of the target \fIfile\fP. This can
then be used for checking \fIhashes\fP, or for caching \fIhashes\fP to produce faster output during hashing runs. There are two types of filesystem attribute, trusted attributes,
which can only be set and read by root, and user attributes, which can be set and read by any user that has the appropriate permissions for the \fIfile\fP.
.PP
Hashes can be stored against files by using the \fB-xattr\fP option to set user attributes:
.PP
.nf
.fam C
    $ hashrat \-sha256 \-r . \-xattr

.fam T
.fi
And using the \fB-txattr\fP flag to set trusted attributes (you must be root to set trusted attributes):
.PP
.nf
.fam C
    # hashrat \-sha256 \-r . \-txattr

.fam T
.fi
When checking either flag can be used, but \fBhashrat\fP will always use trusted attributes when running as root, if those are avaialable, otherwise it will fall
back to user attributes.
.PP
.nf
.fam C
    $ hashrat \-c \-sha256 \-r . \-xattr

.fam T
.fi
The \fB-cache\fP option allows using stored \fIhashes\fP rather than regenerating \fIhashes\fP. It only considers \fIhashes\fP stored in user attributes at current.
.PP
.nf
.fam C
    $ hashrat \-r . \-cache

.fam T
.fi
This makes getting a report of \fIhashes\fP considerably faster, but it runs the risk that the \fIhashes\fP may not be accurate. Hashrat will only output a \fIhash\fP stored in \fIfile\fP
attributes if the storage time of the \fIhash\fP is younger than the modify time (mtime) of the \fIfile\fP, however, this means an attacker could change the modify time of the \fIfile\fP
to hide changes they've made. Thus this feature should not be used for security checking purposes (but should be safe for uses like finding files that have changed and
need to be backed up, for instance).
.SH AUTHOR
The \fBhashrat\fP was written by Colum Paget <colums.projects@gmail.com>.
.PP
This manual page was written by Joao Eriberto Mota Filho <eriberto@debian.org>
for the Debian project (but may be used by others).