diff options
author | James Crayne <jim.crayne@gmail.com> | 2014-04-23 03:00:21 -0400 |
---|---|---|
committer | James Crayne <jim.crayne@gmail.com> | 2014-04-23 03:00:21 -0400 |
commit | 113bd47e870393601932d2b328d7c4be444c7a20 (patch) | |
tree | 89fbbfe1d4c12bf5c5a705a935012abe0fe4588d /kiki.hs | |
parent | d16b42333d2ba46ae348a16cb79984fdcedcc8d3 (diff) |
Documentation
Diffstat (limited to 'kiki.hs')
-rw-r--r-- | kiki.hs | 47 |
1 files changed, 47 insertions, 0 deletions
@@ -458,13 +458,25 @@ kiki_usage = putStr . unlines $ | |||
458 | ," current working key (the one shown by --show-wk)." | 458 | ," current working key (the one shown by --show-wk)." |
459 | ,"" | 459 | ,"" |
460 | ," --keypairs KEYSPEC KEYSPEC..." | 460 | ," --keypairs KEYSPEC KEYSPEC..." |
461 | ," A keypair is a secret key coupled with it's corresponding public" | ||
462 | ," key, both of which are ordinarily stored in a single file in pem" | ||
463 | ," format. Users incognisant of the fact that the public key (which" | ||
464 | ," is also stored separately) is in this file, often think of it as" | ||
465 | ," their secret key file." | ||
466 | ,"" | ||
461 | ," Each KEYSPEC specifies that a key should match the content and" | 467 | ," Each KEYSPEC specifies that a key should match the content and" |
462 | ," timestamp of an external PKCS #1 private RSA key file." | 468 | ," timestamp of an external PKCS #1 private RSA key file." |
463 | ," " | 469 | ," " |
464 | ," KEYSPEC ::= SPEC=FILE{CMD} " | 470 | ," KEYSPEC ::= SPEC=FILE{CMD} " |
465 | ,"" | 471 | ,"" |
472 | ," The form of SPEC is documented below. If there is only one master" | ||
473 | ," key in your keyring and only one key is used for each purpose, then" ," it is possible for SPEC in this case to merely be a tag which offers" | ||
474 | ," information about what this key is used for, for example, any of" | ||
475 | ," `tor', `ssh-client', `ssh-host', or `strongswan' will do." | ||
476 | ,"" | ||
466 | ," If neither SPEC or FILE match any keys, then the CMD will be " | 477 | ," If neither SPEC or FILE match any keys, then the CMD will be " |
467 | ," executed in order to create the FILE." | 478 | ," executed in order to create the FILE." |
479 | |||
468 | ,"" | 480 | ,"" |
469 | ,"Output:" | 481 | ,"Output:" |
470 | ," --show-wk Show fingerprints for the working key (which will be used to" | 482 | ," --show-wk Show fingerprints for the working key (which will be used to" |
@@ -490,6 +502,41 @@ kiki_usage = putStr . unlines $ | |||
490 | ," Outputs the secret crypto-coin key in Wallet Input Format." | 502 | ," Outputs the secret crypto-coin key in Wallet Input Format." |
491 | ,"" | 503 | ,"" |
492 | ," --help Shows this help screen." | 504 | ," --help Shows this help screen." |
505 | ,"" | ||
506 | ,"Specifying keys on the kiki command line:" | ||
507 | ,"" | ||
508 | ," SPEC ::= MASTER/SUBKEY" | ||
509 | ,"" | ||
510 | ," SPEC indicates a specific key in the keyring, in it's longest incarnation," | ||
511 | ," it is of the form MASTER/SUBKEY where MASTER and SUBKEY are documented below." | ||
512 | ," If kiki can infer the key unambiguously, either via the command in question or" | ||
513 | ," the contents of the keyring, then it is permissable to ommit either MASTER or" | ||
514 | ," SUBKEY, in which case the slash may also be ommitted unless it is used via its" | ||
515 | ," position to indicate whether a SUBKEY or MASTER is intended." | ||
516 | ,"" | ||
517 | ," MASTER may be any of" | ||
518 | ," * The tail end of a fingerprint prefixed by 'fp:'" | ||
519 | ," * A sub-string of a user id (without slashes) prefixed by 'u:'" | ||
520 | ," * 40 characters of hexidecimal (kiki will assume this to be a fingerprint)" | ||
521 | ," * A sub-string of a user id (without slashes, the prefix 'u:' is optional)" | ||
522 | ,"" | ||
523 | ," SUBKEY may be any of" | ||
524 | ," * The tail end of a fingerprint prefixed by 'fp:'" | ||
525 | ," * An exact match of a usage tag prefixed by 't:'" | ||
526 | ," * 40 characters of hexidecimal (kiki will assume this to be a fingerprint)" | ||
527 | ," * An exact match of a usage tag (The prefix 't:' is optional)" | ||
528 | ,"" | ||
529 | ," In parsing the spec, kiki will attempt to match the string to one of the" | ||
530 | ," above formats, in the order presented." | ||
531 | ,"" | ||
532 | ," Examples of valid SPEC strings:" | ||
533 | ,"" | ||
534 | ," fp:4A39F/tor" | ||
535 | ," u:joe/tor" | ||
536 | ," u:joe/t:tor" | ||
537 | ," u:joe/fp:4abf30" | ||
538 | ," joe/tor" | ||
539 | ," 5E24CD442AA6965D2012E62A905C24185D5379C2" | ||
493 | ] | 540 | ] |
494 | 541 | ||
495 | doAutosign rt kd@(KeyData k ksigs umap submap) = ops | 542 | doAutosign rt kd@(KeyData k ksigs umap submap) = ops |