summaryrefslogtreecommitdiff
path: root/src/monkeysphere-host
blob: 9dcd331d51c41c4577e17a919c36821e35faf638 (plain)
  1. #!/usr/bin/env bash
  2. # monkeysphere-host: Monkeysphere host admin tool
  3. #
  4. # The monkeysphere scripts are written by:
  5. # Jameson Rollins <jrollins@finestructure.net>
  6. # Jamie McClelland <jm@mayfirst.org>
  7. # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
  8. # Micah Anderson <micah@riseup.net>
  9. #
  10. # They are Copyright 2008-2009, and are all released under the GPL,
  11. # version 3 or later.
  12. ########################################################################
  13. set -e
  14. # set the pipefail option so pipelines fail on first command failure
  15. set -o pipefail
  16. PGRM=$(basename $0)
  17. SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
  18. export SYSSHAREDIR
  19. . "${SYSSHAREDIR}/defaultenv"
  20. . "${SYSSHAREDIR}/common"
  21. SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"}
  22. export SYSDATADIR
  23. # sharedir for host functions
  24. MHSHAREDIR="${SYSSHAREDIR}/mh"
  25. # datadir for host functions
  26. MHDATADIR="${SYSDATADIR}/host"
  27. # host pub key files
  28. HOST_KEY_FILE="${SYSDATADIR}/ssh_host_rsa_key.pub.gpg"
  29. # UTC date in ISO 8601 format if needed
  30. DATE=$(date -u '+%FT%T')
  31. # unset some environment variables that could screw things up
  32. unset GREP_OPTIONS
  33. ########################################################################
  34. # FUNCTIONS
  35. ########################################################################
  36. usage() {
  37. cat <<EOF >&2
  38. usage: $PGRM <subcommand> [options] [args]
  39. Monkeysphere host admin tool.
  40. subcommands:
  41. import-key (i) FILE NAME[:PORT] import existing ssh key to gpg
  42. show-key (s) output all host key information
  43. publish-key (p) publish host key to keyserver
  44. set-expire (e) [EXPIRE] set host key expiration
  45. add-hostname (n+) NAME[:PORT] add hostname user ID to host key
  46. revoke-hostname (n-) NAME[:PORT] revoke hostname user ID
  47. add-revoker (r+) KEYID|FILE add a revoker to the host key
  48. revoke-key generate and/or publish revocation
  49. certificate for host key
  50. version (v) show version number
  51. help (h,?) this help
  52. See ${PGRM}(8) for more info.
  53. EOF
  54. }
  55. # function to interact with the gpg keyring
  56. gpg_host() {
  57. GNUPGHOME="$GNUPGHOME_HOST" gpg --no-greeting --quiet --no-tty "$@"
  58. }
  59. # command to list the info about the host key, in colon format, to
  60. # stdout
  61. gpg_host_list() {
  62. gpg_host --list-keys --with-colons --fixed-list-mode \
  63. --with-fingerprint --with-fingerprint \
  64. "0x${HOST_FINGERPRINT}!"
  65. }
  66. # command for edit key scripts, takes scripts on stdin
  67. gpg_host_edit() {
  68. gpg_host --command-fd 0 --edit-key "0x${HOST_FINGERPRINT}!" "$@"
  69. }
  70. # export the host public key to the monkeysphere gpg pub key file
  71. update_gpg_pub_file() {
  72. log debug "updating openpgp public key file '$HOST_KEY_FILE'..."
  73. gpg_host --export --armor --export-options export-minimal \
  74. "0x${HOST_FINGERPRINT}!" > "$HOST_KEY_FILE"
  75. }
  76. # load the host fingerprint into the fingerprint variable, using the
  77. # export gpg pub key file
  78. # FIXME: this seems much less than ideal, with all this temp keyring
  79. # stuff. is there a way we can do this without having to create temp
  80. # files? what if we stored the fingerprint in MHDATADIR/fingerprint?
  81. load_fingerprint() {
  82. if [ -f "$HOST_KEY_FILE" ] ; then
  83. HOST_FINGERPRINT=$( \
  84. (FUBAR=$(msmktempdir) && export GNUPGHOME="$FUBAR" \
  85. && gpg --quiet --import \
  86. && gpg --quiet --list-keys --with-colons --with-fingerprint \
  87. && rm -rf "$FUBAR") <"$HOST_KEY_FILE" \
  88. | grep '^fpr:' | cut -d: -f10 )
  89. else
  90. failure "host key gpg pub file not found."
  91. fi
  92. }
  93. # load the host fingerprint into the fingerprint variable, using the
  94. # gpg host secret key
  95. load_fingerprint_secret() {
  96. HOST_FINGERPRINT=$( \
  97. gpg_host --list-secret-key --with-colons --with-fingerprint \
  98. | grep '^fpr:' | cut -d: -f10 )
  99. }
  100. # fail if host key present
  101. check_host_key() {
  102. [ ! -s "$HOST_KEY_FILE" ] \
  103. || failure "An OpenPGP host key already exists."
  104. }
  105. # fail if host key not present
  106. check_host_no_key() {
  107. [ -s "$HOST_KEY_FILE" ] \
  108. || failure "You don't appear to have a Monkeysphere host key on this server.
  109. Please run 'monkeysphere-host import-key...' first."
  110. }
  111. # return 0 if user ID was found.
  112. # return 1 if user ID not found.
  113. find_host_userid() {
  114. local userID="$1"
  115. local tmpuidMatch
  116. # match to only "unknown" user IDs (host has no need for ultimate trust)
  117. tmpuidMatch="uid:-:$(echo $userID | gpg_escape)"
  118. # See whether the requsted user ID is present
  119. gpg_host_list | cut -f1,2,10 -d: | \
  120. grep -q -x -F "$tmpuidMatch" 2>/dev/null
  121. }
  122. # show info about the host key
  123. show_key() {
  124. local GNUPGHOME
  125. local TMPSSH
  126. local revokers
  127. # tmp gpghome dir
  128. export GNUPGHOME=$(msmktempdir)
  129. # trap to remove tmp dir if break
  130. trap "rm -rf $GNUPGHOME" EXIT
  131. # import the host key into the tmp dir
  132. gpg --quiet --import <"$HOST_KEY_FILE"
  133. # create the ssh key
  134. TMPSSH="$GNUPGHOME"/ssh_host_key_rsa_pub
  135. gpg --export | openpgp2ssh 2>/dev/null >"$TMPSSH"
  136. # get the gpg fingerprint
  137. HOST_FINGERPRINT=$(gpg --quiet --list-keys --with-colons --with-fingerprint \
  138. | grep '^fpr:' | cut -d: -f10 )
  139. # list the host key info
  140. # FIXME: make no-show-keyring work so we don't have to do the grep'ing
  141. # FIXME: can we show uid validity somehow?
  142. gpg --list-keys --fingerprint \
  143. --list-options show-unusable-uids 2>/dev/null \
  144. | grep -v "^${GNUPGHOME}/pubring.gpg$" \
  145. | egrep -v '^-+$'
  146. # list revokers, if there are any
  147. revokers=$(gpg --list-keys --with-colons --fixed-list-mode \
  148. | awk -F: '/^rvk:/{ print $10 }' )
  149. if [ "$revokers" ] ; then
  150. echo "The following keys are allowed to revoke this host key:"
  151. for key in $revokers ; do
  152. echo "revoker: $key"
  153. done
  154. echo
  155. fi
  156. # list the pgp fingerprint
  157. echo "OpenPGP fingerprint: $HOST_FINGERPRINT"
  158. # list the ssh fingerprint
  159. echo -n "ssh fingerprint: "
  160. ssh-keygen -l -f "$TMPSSH" | awk '{ print $1, $2, $4 }'
  161. # remove the tmp file
  162. trap - EXIT
  163. rm -rf "$GNUPGHOME"
  164. }
  165. ########################################################################
  166. # MAIN
  167. ########################################################################
  168. # load configuration file
  169. [ -e ${MONKEYSPHERE_HOST_CONFIG:="${SYSCONFIGDIR}/monkeysphere-host.conf"} ] \
  170. && . "$MONKEYSPHERE_HOST_CONFIG"
  171. # set empty config variable with ones from the environment, or with
  172. # defaults
  173. LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=$LOG_LEVEL}
  174. KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER}
  175. CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=$CHECK_KEYSERVER}
  176. MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=$MONKEYSPHERE_USER}
  177. MONKEYSPHERE_GROUP=$(get_primary_group "$MONKEYSPHERE_USER")
  178. PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT}
  179. # other variables
  180. GNUPGHOME_HOST=${MONKEYSPHERE_GNUPGHOME_HOST:="${MHDATADIR}"}
  181. LOG_PREFIX=${MONKEYSPHERE_LOG_PREFIX:='ms: '}
  182. # export variables needed in su invocation
  183. export DATE
  184. export LOG_LEVEL
  185. export KEYSERVER
  186. export CHECK_KEYSERVER
  187. export MONKEYSPHERE_USER
  188. export MONKEYSPHERE_GROUP
  189. export PROMPT
  190. export GNUPGHOME_HOST
  191. export GNUPGHOME
  192. export HOST_FINGERPRINT
  193. export LOG_PREFIX
  194. # get subcommand
  195. COMMAND="$1"
  196. [ "$COMMAND" ] || failure "Type '$PGRM help' for usage."
  197. shift
  198. case $COMMAND in
  199. 'import-key'|'i')
  200. check_host_key
  201. source "${MHSHAREDIR}/import_key"
  202. import_key "$@"
  203. ;;
  204. 'show-key'|'show'|'s')
  205. check_host_no_key
  206. show_key
  207. ;;
  208. 'set-expire'|'extend-key'|'e')
  209. check_host_no_key
  210. load_fingerprint
  211. source "${MHSHAREDIR}/set_expire"
  212. set_expire "$@"
  213. ;;
  214. 'add-hostname'|'add-name'|'n+')
  215. check_host_no_key
  216. load_fingerprint
  217. source "${MHSHAREDIR}/add_hostname"
  218. add_hostname "$@"
  219. ;;
  220. 'revoke-hostname'|'revoke-name'|'n-')
  221. check_host_no_key
  222. load_fingerprint
  223. source "${MHSHAREDIR}/revoke_hostname"
  224. revoke_hostname "$@"
  225. ;;
  226. 'add-revoker'|'r+')
  227. check_host_no_key
  228. load_fingerprint
  229. source "${MHSHAREDIR}/add_revoker"
  230. add_revoker "$@"
  231. ;;
  232. 'revoke-key')
  233. check_host_no_key
  234. load_fingerprint
  235. source "${MHSHAREDIR}/revoke_key"
  236. revoke_key "$@"
  237. ;;
  238. 'publish-key'|'publish'|'p')
  239. check_host_no_key
  240. load_fingerprint
  241. source "${MHSHAREDIR}/publish_key"
  242. publish_key
  243. ;;
  244. 'diagnostics'|'d')
  245. check_host_no_key
  246. load_fingerprint
  247. source "${MHSHAREDIR}/diagnostics"
  248. diagnostics
  249. ;;
  250. 'update-gpg-pub-file')
  251. load_fingerprint_secret
  252. update_gpg_pub_file
  253. ;;
  254. 'version'|'v')
  255. version
  256. ;;
  257. '--help'|'help'|'-h'|'h'|'?')
  258. usage
  259. ;;
  260. *)
  261. failure "Unknown command: '$COMMAND'
  262. Type '$PGRM help' for usage."
  263. ;;
  264. esac