1 ## Remoteusage without password-free login requirement
3 This is alternative to [[remoteusage|remoteusage]] where password-free
4 login is not a requirement. See [[remoteusage|remoteusage]] page for
5 other requirements and general information.
7 This solution uses one pre-made ssh connection where the client is put
8 into "master" mode (-M) for connection sharing. The wrapper script then
9 uses the control socket created by this pre-made ssh connection for
12 Write the following code to a file, for example `remote-notmuch.sh`.
13 There is just one line to that normally needs configuration:
15 readonly SSH_CONTROL_SOCK='~'/.ssh/master-user@host:22
17 the options howto are presented after the script.
23 # http://notmuchmail.org/remoteusage/aboriginal/
27 readonly SSH_CONTROL_SOCK='~'/.ssh/master-user@host:22
29 readonly notmuch=notmuch
31 printf -v ARGS '%q ' "$@" # bash feature
33 readonly SSH_CONTROL_ARGS='-oControlMaster=no -S '$SSH_CONTROL_SOCK
35 if ssh $SSH_CONTROL_ARGS 0.1 $notmuch $ARGS 2>>/dev/null
40 # continuing here in case ssh exited with nonzero value.
43 'config get user.primary_email') echo 'nobody@nowhere.invalid'; exit 0 ;;
44 'config get user.name') echo 'nobody'; exit 0 ;;
45 'count'*) echo 1; exit 0 ;;
46 'search-tags'*) echo 'errors'; exit 0 ;;
47 'search'*'--output=tags'*) echo 'errors'; exit 0 ;;
50 if ssh $SSH_CONTROL_ARGS -O check 0.1
52 echo ' Control socket is alive but something failed during data transmission.'
56 echo " See`sed '1d;2d;s/.//;q' "$0"` for help."
60 Easiest way to test this script is to run the pre-made ssh connection
61 using the following command line:
63 ssh -M -S '~'/.ssh/master-user@host:22 [user@]remotehost
65 (replace `[user@]remotehost` with your login info). Doing this the
66 above script can be run unmodified. After the above command has been
67 run on one terminal, enter `chmod +x remote-notmuch.sh` in another
68 terminal and then test the script with `./remote-notmuch.sh help`
70 Note that the '~' is inside single quotes for a reason. In this
71 case shell never expand it to `$HOME` -- ssh does it by not reading
72 `$HOME` but checking the real user home directory from `/etc/passewd`.
73 For security purposes this is just how it should be.
77 The path `'~'/.ssh/master-user@host:22` might look too generic to be
78 used as is as the control socket after initial testing (but it can
79 be used). It is presented as a template for what could be configured
80 to `$HOME/.ssh/config`. For example:
83 ControlPath ~/.ssh/master-%h@%p:%r
85 is a good entry to be written in `$HOME/.ssh/config`;
86 [[remoteusage|remoteusage]] uses the same. Now, let's say you'd
87 make your pre-made ssh connection with command
89 ssh -M alice@example.org
92 `readonly SSH_CONTROL_SOCK='~'/.ssh/master-alice@example.org:22`
93 to the `./remote-notmuch.sh` wrapper script testing with
94 `./remote-notmuch.sh help` should work fine.
96 ## Configure Emacs on the client computer ##
98 See the section *Configure Emacs on the client computer* in
99 [[remoteusage|remoteusage]] how to do this. The instructions are the same.
103 Original [BSD Licence](http://en.wikipedia.org/wiki/BSD_licenses)
105 When 3 rd. clause was removed, the new license was not original anymore.
106 Similarly, the requirement for this version are the same as in
107 [[remoteusage|remoteusage]] page except the 3 rd. requirement
108 (password-free login) is not effective here.