summaryrefslogtreecommitdiff
path: root/man/man1/monkeysphere.1
blob: 410a5d7d4745d6e20f2f91086ce5a5ed66867e16 (plain) 
    

  1. .TH MONKEYSPHERE "1" "June 2008" "monkeysphere 0.1" "User Commands"
    2. 

  2. .SH NAME
    3. 

  3. monkeysphere \- MonkeySphere client user interface
    4. 

  4. .SH SYNOPSIS
    5. 

  5. .B monkeysphere \fIcommand\fP [\fIargs\fP]
    6. 

  6. .SH DESCRIPTION
    7. 

  7. .PP
    8. 

  8. MonkeySphere is a system to leverage the OpenPGP Web of Trust for ssh
    9. 

  9. authentication and encryption.  OpenPGP keys are tracked via GnuPG,
    10. 

  10. and added to the ssh authorized_keys and known_hosts files to be used
    11. 

  11. for authentication and encryption of ssh connection.
    12. 

  12. 

  13. \fBmonkeysphere\fP is the MonkeySphere client utility.
    14. 

  14. .PD
    15. 

  15. .SH SUBCOMMANDS
    16. 

  16. \fBmonkeysphere\fP takes various subcommands:
    17. 

  17. .TP
    18. 

  18. .B update-known_hosts [HOST]...
    19. 

  19. Update the known_hosts file.  For each specified host, gpg will be
    20. 

  20. queried for a key associated with the host URI (see HOST URIs),
    21. 

  21. querying a keyserver if none is found in the user's keychain. search
    22. 

  22. for a gpg key for the host in the Web of Trust.  If a key is found, it
    23. 

  23. will be added to the host_keys cache (see KEY CACHES) and any ssh keys
    24. 

  24. for the host will be removed from the user's known_hosts file.  If the
    25. 

  25. found key is acceptable (see KEY ACCEPTABILITY), then the host's gpg
    26. 

  26. key will be added to the known_hosts file.  If no gpg key is found for
    27. 

  27. the host, then nothing is done.  If no hosts are specified, all hosts
    28. 

  28. listed in the known_hosts file will be processed.  `k' may be used in
    29. 

  29. place of `update-known_hosts'.
    30. 

  30. .TP
    31. 

  31. .B update-userids [USERID]...
    32. 

  32. Add/update a userid in the authorized_user_ids file.  The user IDs
    33. 

  33. specified should be exact matches to OpenPGP user IDs.  For each
    34. 

  34. specified user ID, gpg will be queried for a key associated with that
    35. 

  35. user ID, querying a keyserver if none is found in the user's keychain.
    36. 

  36. If a key is found, it will be added to the user_keys cache (see KEY
    37. 

  37. CACHES) and the user ID will be added to the user's
    38. 

  38. authorized_user_ids file (if it wasn't already present).
    39. 

  39. .TP
    40. 

  40. .B update-authorized_keys
    41. 

  41. Update the monkeysphere authorized_keys file.  The monkeysphere
    42. 

  42. authorized_keys file will be regenerated from the valid keys in the
    43. 

  43. user_key cache, and the user's independently controlled
    44. 

  44. authorized_keys file (usually ~/.ssh/authorized_keys).
    45. 

  45. .TP
    46. 

  46. .B gen-ae-subkey KEYID
    47. 

  47. Generate an `ae` capable subkey.  For the primary key with the
    48. 

  48. specified key ID, generate a subkey with "authentication" and
    49. 

  49. "encryption" capability that can be used for MonkeySphere
    50. 

  50. transactions.
    51. 

  51. .TP
    52. 

  52. .B help
    53. 

  53. Output a brief usage summary.  `h' or `?' may be used in place of
    54. 

  54. `help'.
    55. 

  55. .PD
    56. 

  56. .SH KEY ACCEPTABILITY
    57. 

  57. GPG keys are considered acceptable if the following criteria are met:
    58. 

  58. .PD
    59. 

  59. .TP
    60. 

  60. .B capability
    61. 

  61. The key must have both the "authentication" and "encrypt" capability
    62. 

  62. flags.
    63. 

  63. .TP
    64. 

  64. .B validity
    65. 

  65. The key must be "fully" valid, and must not be expired or revoked.
    66. 

  66. .PD
    67. 

  67. .SH KEY CACHES
    68. 

  68. Monkeysphere keeps track of keys in key cache directories.  The files
    69. 

  69. in the cache are named with the format "USERID_HASH.PUB_KEY_ID", where
    70. 

  70. USERID_HASH is a hash of the exact OpenPGP user ID, and PUB_KEY_ID is
    71. 

  71. the key ID of the primary key.  If the user/key ID combo exists in the
    72. 

  72. Web of Trust but is not acceptable, then the file is empty.  If the
    73. 

  73. primary key has at least one acceptable sub key, then an ssh-style
    74. 

  74. key, converted from the OpenPGP key, of all acceptable subkeys will be
    75. 

  75. stored in the cache file, one per line.  known_hosts style key lines
    76. 

  76. will be stored in the host_keys cache files, and authorized_keys style
    77. 

  77. key lines will be stored in the user_keys cache files.  OpenPGP keys
    78. 

  78. are converted to ssh-style keys with the openpgp2ssh utility (see `man
    79. 

  79. openpgp2ssh').
    80. 

  80. .PD
    81. 

  81. .SH FILES
    82. 

  82. .PD 1
    83. 

  83. .TP
    84. 

  84. ~/.config/monkeysphere/monkeysphere.conf
    85. 

  85. User monkeysphere config file.
    86. 

  86. .TP
    87. 

  87. /etc/monkeysphere/monkeysphere.conf
    88. 

  88. System-wide monkeysphere config file.
    89. 

  89. .TP
    90. 

  90. ~/.config/monkeysphere/authorized_user_ids
    91. 

  91. GPG user IDs associated with keys that will be checked for addition to
    92. 

  92. the authorized_keys file. 
    93. 

  93. .TP
    94. 

  94. ~/.config/monkeysphere/authorized_keys
    95. 

  95. Monkeysphere generated authorized_keys file.
    96. 

  96. .TP
    97. 

  97. ~/.config/monkeysphere/user_keys
    98. 

  98. User keys cache directory.
    99. 

  99. .TP
    100. 

  100. ~/.config/monkeysphere/host_keys
    101. 

  101. Host keys cache directory.
    102. 

  102. .PD
    103. 

  103. .SH AUTHOR
    104. 

  104. Written by Jameson Rollins <jrollins@fifthhorseman.net>
    105. 

  105. .SH SEE ALSO
    106. 

  106. .BR ssh (1),
    107. 

  107. .BR gpg (1),
    108. 

  108. .BR monkeysphere-server (8)
    109.
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-28 20:03:04 +0000