arno
/
simplesshd
mirror of http://galexander.org/git/simplesshd.git
1
0
Fork 0
Code Issues Releases Wiki Activity

re-organize preferences into categories

Browse Source
sigsegv_dump
Greg Alexander 6 years ago
parent 7399dcb1c6
commit 932508f702
3 changed files with 61 additions and 56 deletions
Show Stats Download Patch File Download Diff File

1
NOTES
Unescape View File

@ -646,7 +646,6 @@ So after some internal debate, I decided to do two changes:
I look forward to seeing if anyone complains about it. I look forward to seeing if anyone complains about it.
XXX - make preference categories
XXX - test on optimus v XXX - test on optimus v
XXX - publish XXX - publish

70
doc/index.html
Unescape View File

@ -66,6 +66,13 @@ of these settings to take effect.</p>
<dt>Start on Boot</dt> <dt>Start on Boot</dt>
<dd>Automatically start the SimpleSSHD service when the phone powers on.</dd> <dd>Automatically start the SimpleSSHD service when the phone powers on.</dd>
<dt>Start on Open</dt>
<dd>Run the SimpleSSHD service whenever the app is launched. The "STOP"
button will be replaced with a "QUIT" button that stops the service and
exits the app. This is useful if you want to only run the service when
you really need it -- start the app to start listening for connections,
and then click "QUIT" when you are done.</dd>
<dt>Foreground Service</dt> <dt>Foreground Service</dt>
<dd>Run the SimpleSSHD service as an Android "foreground service." This <dd>Run the SimpleSSHD service as an Android "foreground service." This
means a notification will be displayed for the service (you might be able means a notification will be displayed for the service (you might be able
@ -74,38 +81,10 @@ On newer versions of Android (since Marshmallow), this may also make
SimpleSSHD more responsive if the phone has been in Doze mode. It does SimpleSSHD more responsive if the phone has been in Doze mode. It does
not seem to increase battery consumption much.</dd> not seem to increase battery consumption much.</dd>
<dt>Start on Open</dt>
<dd>Run the SimpleSSHD service whenever the app is launched. The "STOP"
button will be replaced with a "QUIT" button that stops the service and
exits the app. This is useful if you want to only run the service when
you really need it -- start the app to start listening for connections,
and then click "QUIT" when you are done.</dd>
<dt>Port Number</dt> <dt>Port Number</dt>
<dd>This is the port number that SimpleSSHD will listen on. It must be <dd>This is the port number that SimpleSSHD will listen on. It must be
greater than 1024 (because SimpleSSHD does not have root).</dd> greater than 1024 (because SimpleSSHD does not have root).</dd>
<dt>SSH Path</dt>
<dd>Path for general dropbear files, which now defaults to
the app-private directory (usually something like
<tt>/data/data/org.galexander.sshd/files</tt>).
Most importantly, this is where
<tt>authorized_keys</tt> is found. It is also where host keys wind up
(they are created on demand), and where temporary files go. This path
should probably be under <tt>/sdcard</tt>.</dd>
<dt>Login Shell</dt>
<dd>Path to the command shell. The default Android shell is
<tt>/system/bin/sh</tt>, but you may prefer to use the one that comes with
busybox or whatever. If you set it to the su binary (i.e.,
<tt>/system/xbin/su</tt>), then scp, sftp, and rsync will run as root and
should be able to access files outside of <tt>/sdcard</tt>. If the name
of the shell contains "<tt>su</tt>" in it, instead of putting
"<tt>-</tt>" before <tt>argv[0]</tt> to indicate the login shell,
SimpleSSHD puts "<tt>-</tt>" as <tt>argv[1]</tt>. That is, a regular
login shell would be invoked as "<tt>-sh</tt>", but su will be invoked as
"<tt>su -</tt>".</dd>
<dt>Buffer hack for rsync+SuperSU</dt> <dt>Buffer hack for rsync+SuperSU</dt>
<dd>A bug in SuperSU interacts with an infelicity in rsync to cause an <dd>A bug in SuperSU interacts with an infelicity in rsync to cause an
occasional deadlock. This is a real pain because I use SuperSU+rsync occasional deadlock. This is a real pain because I use SuperSU+rsync
@ -115,12 +94,6 @@ should be enabled if you use rsync with SuperSU. It adds a miniscule
overhead to rsync, but isn't harmful even if you aren't using overhead to rsync, but isn't harmful even if you aren't using
SuperSU.</dd> SuperSU.</dd>
<dt>Home Directory</dt>
<dd>The login shell's home directory, which also defaults
to the app-private directory.
This is where your ssh session starts out, and is where <tt>.profile</tt>
will be found if it is present.</dd>
<dt>Extra Commandline</dt> <dt>Extra Commandline</dt>
<dd>You can specify additional commandline options for dropbear server. <dd>You can specify additional commandline options for dropbear server.
The options which are hardcoded are: The options which are hardcoded are:
@ -136,6 +109,33 @@ A common use would be "<tt>ENV=/sdcard/ssh/.profile</tt>", if your device has a
build of <tt>mksh</tt> that does not execute a <tt>.profile</tt> build of <tt>mksh</tt> that does not execute a <tt>.profile</tt>
automatically.</dd> automatically.</dd>
<dt>SSH Path</dt>
<dd>Path for general dropbear files, which now defaults to
the app-private directory (usually something like
<tt>/data/data/org.galexander.sshd/files</tt>).
Most importantly, this is where
<tt>authorized_keys</tt> is found. It is also where host keys wind up
(they are created on demand), and where temporary files go. This path
should probably be under <tt>/sdcard</tt>.</dd>
<dt>Home Directory</dt>
<dd>The login shell's home directory, which also defaults
to the app-private directory.
This is where your ssh session starts out, and is where <tt>.profile</tt>
will be found if it is present.</dd>
<dt>Login Shell</dt>
<dd>Path to the command shell. The default Android shell is
<tt>/system/bin/sh</tt>, but you may prefer to use the one that comes with
busybox or whatever. If you set it to the su binary (i.e.,
<tt>/system/xbin/su</tt>), then scp, sftp, and rsync will run as root and
should be able to access files outside of <tt>/sdcard</tt>. If the name
of the shell contains "<tt>su</tt>" in it, instead of putting
"<tt>-</tt>" before <tt>argv[0]</tt> to indicate the login shell,
SimpleSSHD puts "<tt>-</tt>" as <tt>argv[1]</tt>. That is, a regular
login shell would be invoked as "<tt>-sh</tt>", but su will be invoked as
"<tt>su -</tt>".</dd>
<h2>Frequently Asked Questions</h2> <h2>Frequently Asked Questions</h2>
@ -171,7 +171,7 @@ harmless.
<ul> <ul>
<li> <b>2018/05/19 Version 19:</b> Use the app-private directory by <li> <b>2018/05/19 Version 19:</b> Use the app-private directory by
default on new installs for the SSH/home dir. default on new installs for the SSH/home dir. Organize settings.
<li> <b>2018/05/16 Version 18:</b> Use correct idiom for <tt>su</tt> as a <li> <b>2018/05/16 Version 18:</b> Use correct idiom for <tt>su</tt> as a
login shell (so busybox <tt>su</tt> can work). Add environment variables login shell (so busybox <tt>su</tt> can work). Add environment variables
to settings. to settings.

46
res/xml/preferences.xml
Unescape View File

@ -1,44 +1,32 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"> <PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
<PreferenceCategory android:title="Startup">
<CheckBoxPreference <CheckBoxPreference
android:key="onboot" android:key="onboot"
android:title="Start on Boot" android:title="Start on Boot"
android:defaultValue="false" /> android:defaultValue="false" />
<CheckBoxPreference
android:key="foreground"
android:title="Foreground Service"
android:summary="Enable a notification while running, and run with more priority (especially in Doze mode)."
android:defaultValue="true" />
<CheckBoxPreference <CheckBoxPreference
android:key="onopen" android:key="onopen"
android:title="Start on Open" android:title="Start on Open"
android:summary="Start the service when the app is launched (and quit app when stopping service)." android:summary="Start the service when the app is launched (and quit app when stopping service)."
android:defaultValue="false" /> android:defaultValue="false" />
<CheckBoxPreference
android:key="foreground"
android:title="Foreground Service"
android:summary="Enable a notification while running, and run with more priority (especially in Doze mode)."
android:defaultValue="true" />
</PreferenceCategory>
<PreferenceCategory android:title="Dropbear">
<EditTextPreference <EditTextPreference
android:key="port" android:key="port"
android:title="Port Number" android:title="Port Number"
android:summary="Must be greater than 1024." android:summary="Must be greater than 1024."
android:numeric="integer" android:numeric="integer"
android:defaultValue="2222" /> android:defaultValue="2222" />
<EditTextPreference
android:key="path"
android:title="SSH Path"
android:summary="Location of misc dropbear files (put authorized_keys here)."
android:defaultValue="/xxx" />
<EditTextPreference
android:key="shell"
android:title="Login Shell"
android:summary="Location of sh binary."
android:defaultValue="/system/bin/sh" />
<CheckBoxPreference <CheckBoxPreference
android:key="rsyncbuffer" android:key="rsyncbuffer"
android:title="Buffer hack for rsync+SuperSU" android:title="Buffer hack for rsync+SuperSU"
android:defaultValue="false" /> android:defaultValue="false" />
<EditTextPreference
android:key="home"
android:title="Home Directory"
android:summary="Default directory after login (put .profile here)."
android:defaultValue="/xxx" />
<EditTextPreference <EditTextPreference
android:key="extra" android:key="extra"
android:title="Extra Commandline" android:title="Extra Commandline"
@ -49,4 +37,22 @@
android:title="Environment Variables" android:title="Environment Variables"
android:summary="Environment variables (one &quot;name=value&quot; per line)." android:summary="Environment variables (one &quot;name=value&quot; per line)."
android:defaultValue="" /> android:defaultValue="" />
</PreferenceCategory>
<PreferenceCategory android:title="Paths">
<EditTextPreference
android:key="path"
android:title="SSH Path"
android:summary="Location of misc dropbear files (put authorized_keys here)."
android:defaultValue="/xxx" />
<EditTextPreference
android:key="home"
android:title="Home Directory"
android:summary="Default directory after login (put .profile here)."
android:defaultValue="/xxx" />
<EditTextPreference
android:key="shell"
android:title="Login Shell"
android:summary="Location of sh binary."
android:defaultValue="/system/bin/sh" />
</PreferenceCategory>
</PreferenceScreen> </PreferenceScreen>

Write Preview
Loading…
Cancel
Save