2008-02-14 01:57:19 +00:00
< HTML >
< HEAD >
< TITLE > saned.8< / TITLE >
< / HEAD >
2021-02-14 12:22:49 +00:00
< BODY BGCOLOR = #FFFFFF TEXT = #000000 > < H1 ALIGN = CENTER > < IMG SRC = "/images/sane.png" HEIGHT = 117 WIDTH = 346 > < / H1 >
2008-02-14 01:57:19 +00:00
< H1 > saned.8< / H1 >
< HR >
< PRE >
<!-- Manpage converted by man2html 3.0.1 -->
< B > < A HREF = "saned.8.html" > saned(8)< / A > < / B > SANE Scanner Access Now Easy < B > < A HREF = "saned.8.html" > saned(8)< / A > < / B >
< / PRE >
< H2 > NAME< / H2 > < PRE >
saned - SANE network daemon
< / PRE >
< H2 > SYNOPSIS< / H2 > < PRE >
2021-02-14 12:22:49 +00:00
< B > saned< / B > < B > [< / B > < B > -a< / B > < I > [< / I > < I > username< / I > < I > ]< / I > < B > ]< / B > < B > [< / B > < B > -u< / B > < I > username< / I > < B > ]< / B > < B > [< / B > < B > -b< / B > < I > address< / I > < B > ]< / B > < B > [< / B > < B > -p< / B > < I > port< / I > < B > ]< / B > < B > [< / B >
< B > -l< / B > < B > ]< / B > < B > [< / B > < B > -D< / B > < B > ]< / B > < B > [< / B > < B > -o< / B > < B > ]< / B > < B > [< / B > < B > -d< / B > < I > n< / I > < B > ]< / B > < B > [< / B > < B > -e< / B > < B > ]< / B > < B > [< / B > < B > -h< / B > < B > ]< / B >
2008-02-14 01:57:19 +00:00
< / PRE >
< H2 > DESCRIPTION< / H2 > < PRE >
2020-03-29 05:47:02 +00:00
< B > saned< / B > is the SANE (Scanner Access Now Easy) daemon that allows remote
clients to access image acquisition devices available on the local
2008-02-14 01:57:19 +00:00
host.
< / PRE >
< H2 > OPTIONS< / H2 > < PRE >
2022-01-19 20:53:37 +00:00
< B > saned< / B > recognises the following options:
< B > -a< / B > < I > [username]< / I > , < B > --alone< / B > [=< I > username]< / I >
is equivalent to the combination of < B > -l< / B > < B > -D< / B > < B > -u< / B > < I > username< / I > options.
However, < I > username< / I > is optional and running user will only be set
when specified.
< B > -u< / B > < I > username< / I > , < B > --user< / B > =< I > username< / I >
requests that < B > saned< / B > drop root privileges and run as the user
(and group) associated with < I > username< / I > after binding.
< B > -b< / B > < I > address< / I > , < B > --bind< / B > =< I > address< / I >
tells < B > saned< / B > to bind to the < I > address< / I > given.
< B > -p< / B > < I > port< / I > , < B > --port=< / B > < I > port< / I >
tells < B > saned< / B > to listen on the < I > port< / I > given. A value of 0 tells
< B > saned< / B > to pick an unused port. The default is the < B > sane-port< / B >
< B > (6566).< / B >
< B > -l< / B > , < B > --listen< / B >
requests that < B > saned< / B > run in standalone daemon mode. In this
2023-02-07 03:22:48 +00:00
mode, < B > saned< / B > will listen for incoming client connections;
< B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > is not required for < B > saned< / B > operations in this mode.
2022-01-19 20:53:37 +00:00
< B > -D< / B > , < B > --daemonize< / B >
will request < B > saned< / B > to detach from the console and run in the
background.
< B > -o< / B > , < B > --once< / B >
requests that < B > saned< / B > exits after the first client disconnects.
This is useful for debugging.
< B > -d< / B > < I > n< / I > , < B > --debug< / B > =< I > n< / I >
sets the level of < B > saned< / B > debug output to < I > n< / I > . When compiled with
2023-02-07 03:22:48 +00:00
debugging enabled, this flag may be followed by a number to
request more or less debug info. The larger the number, the
more verbose the debug output. E.g., < B > -d128< / B > will request output
of all debug info. A level of 0 produces no output at all. The
2022-01-19 20:53:37 +00:00
default value is 2.
< B > -e< / B > , < B > --stderr< / B >
will divert < B > saned< / B > debug output to stderr instead of the syslog
default.
< B > -h< / B > , < B > --help< / B >
displays a short help message.
2008-02-14 01:57:19 +00:00
2021-02-14 12:22:49 +00:00
If < B > saned< / B > is run from other programs such as < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > , < B > < A HREF = "xinetd.8.html" > xinetd(8)< / A > < / B > and
< B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > , check that program's documentation on how to pass command-
line options.
2020-03-29 05:47:02 +00:00
2008-02-14 01:57:19 +00:00
< / PRE >
< H2 > CONFIGURATION< / H2 > < PRE >
First and foremost: < B > saned< / B > is not intended to be exposed to the internet
2020-03-29 05:47:02 +00:00
or other non-trusted networks. Make sure that access is limited by tcp-
2023-02-07 03:22:48 +00:00
wrappers and/or a firewall setup. Don't depend only on < B > saned< / B > 's own
authentication. Don't run < B > saned< / B > as root if it's not necessary. And do
< B > not< / B > install < B > saned< / B > as setuid root.
2008-02-14 01:57:19 +00:00
2021-02-14 12:22:49 +00:00
The < I > saned.conf< / I > configuration file contains both options for the daemon
2010-02-10 15:23:52 +00:00
and the access list.
< B > data_portrange< / B > = < I > min< / I > < B > _< / B > < I > port< / I > - < I > max< / I > < B > _< / B > < I > port< / I >
2021-02-14 12:22:49 +00:00
Specify the port range to use for the data connection. Pick a
port range between 1024 and 65535; don't pick a too large port
range, as it may have performance issues. Use this option if
2010-02-10 15:23:52 +00:00
your < B > saned< / B > server is sitting behind a firewall. If that firewall
2021-02-14 12:22:49 +00:00
is a Linux machine, we strongly recommend using the Netfilter
2010-02-10 15:23:52 +00:00
< I > nf< / I > < B > _< / B > < I > conntrack< / I > < B > _< / B > < I > sane< / I > module instead.
2020-03-29 05:47:02 +00:00
< B > data_connect_timeout< / B > = < I > timeout< / I >
2021-02-14 12:22:49 +00:00
Specify the time in milliseconds that < B > saned< / B > will wait for a data
connection. Without this option, if the data connection is not
done before the scanner reaches the end of scan, the scanner
will continue to scan past the end and may damage it depending
2023-02-07 03:22:48 +00:00
on the backend. Specify zero to have the old behavior. The
default is 4000ms.
2021-02-14 12:22:49 +00:00
The access list is a list of host names, IP addresses or IP subnets
2023-02-07 03:22:48 +00:00
(CIDR notation) that are permitted to use local SANE devices. IPv6
addresses must be enclosed in brackets, and should always be specified
in their compressed form. Connections from localhost are always permit-
ted. Empty lines and lines starting with a hash mark (#) are ignored. A
line containing the single character ``+'' is interpreted to match any
hostname. This allows any remote machine to use your scanner and may
2010-02-10 15:23:52 +00:00
present a security risk, so this shouldn't be used unless you know what
you're doing.
A sample configuration file is shown below:
# Daemon options
data_portrange = 10000 - 10100
# Access list
2008-02-14 01:57:19 +00:00
scan-client.somedomain.firm
# this is a comment
192.168.0.1
192.168.2.12/29
[::1]
2012-08-27 01:52:45 +00:00
[2001:db8:185e::42:12]/64
2008-02-14 01:57:19 +00:00
2021-02-14 12:22:49 +00:00
The case of the host names does not matter, so AHost.COM is considered
2008-02-14 01:57:19 +00:00
identical to ahost.com.
2010-02-10 15:23:52 +00:00
< / PRE >
2013-10-01 02:17:11 +00:00
< H2 > SERVER DAEMON CONFIGURATION< / H2 > < PRE >
2010-02-10 15:23:52 +00:00
For < B > saned< / B > to work properly in its default mode of operation, it is also
2021-02-14 12:22:49 +00:00
necessary to add the appropriate configuration for < B > < A HREF = "xinetd.8.html" > xinetd(8)< / A > < / B > , < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B >
or < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > (see below). Note that your < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > must support IPv6
if you want to connect to < B > saned< / B > over IPv6; < B > < A HREF = "xinetd.8.html" > xinetd(8)< / A > < / B > , < B > < A HREF = "openbsd-inetd.8.html" > openbsd-inetd(8)< / A > < / B >
and < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > are known to support IPv6, check the documentation for
your < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > daemon.
2013-10-01 02:17:11 +00:00
2021-02-14 12:22:49 +00:00
In the sections below the configuration for < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > , < B > < A HREF = "xinetd.8.html" > xinetd(8)< / A > < / B > and
< B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > are described in more detail.
2013-10-01 02:17:11 +00:00
2020-03-29 05:47:02 +00:00
For the configurations below it is necessary to add a line of the fol-
2013-10-01 02:17:11 +00:00
lowing form to < I > /etc/services< / I > :
sane-port 6566/tcp # SANE network scanner daemon
2020-03-29 05:47:02 +00:00
The official IANA short name for port 6566 is "sane-port". The older
2013-10-01 02:17:11 +00:00
name "sane" is now deprecated.
< / PRE >
< H2 > INETD CONFIGURATION< / H2 > < PRE >
2021-02-14 12:22:49 +00:00
It is required to add a single line to the < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > configuration file
2013-10-01 02:17:11 +00:00
< I > (/etc/inetd.conf)< / I >
2008-02-14 01:57:19 +00:00
The configuration line normally looks like this:
2020-03-29 05:47:02 +00:00
sane-port stream tcp nowait saned.saned /usr/local/sbin/saned
2017-05-22 22:39:44 +00:00
saned
2008-02-14 01:57:19 +00:00
2017-05-22 22:39:44 +00:00
However, if your system uses < B > < A HREF = "tcpd.8.html" > tcpd(8)< / A > < / B > for additional security screening,
2021-02-14 12:22:49 +00:00
you may want to disable < B > saned< / B > access control by putting ``+'' in
2023-02-07 03:22:48 +00:00
< I > saned.conf< / I > and use a line of the following form in < I > /etc/inetd.conf< / I >
instead:
2013-10-01 02:17:11 +00:00
2023-02-07 03:22:48 +00:00
sane-port stream tcp nowait saned.saned /usr/sbin/tcpd
/usr/local/sbin/saned
2008-02-14 01:57:19 +00:00
2020-03-29 05:47:02 +00:00
Note that both examples assume that there is a < B > saned< / B > group and a < B > saned< / B >
user. If you follow this example, please make sure that the access
permissions on the special device are set such that < B > saned< / B > can access
the scanner (the program generally needs read and write access to scan-
2017-05-22 22:39:44 +00:00
ner devices).
2008-02-14 01:57:19 +00:00
2013-10-01 02:17:11 +00:00
< / PRE >
< H2 > XINETD CONFIGURATION< / H2 > < PRE >
2021-02-14 12:22:49 +00:00
If < B > < A HREF = "xinetd.8.html" > xinetd(8)< / A > < / B > is installed on your system instead of < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > the fol-
lowing example for < I > /etc/xinetd.conf< / I > may be helpful:
2008-02-14 01:57:19 +00:00
# default: off
# description: The sane server accepts requests
# for network access to a local scanner via the
# network.
service sane-port
{
port = 6566
socket_type = stream
wait = no
user = saned
group = saned
2017-05-22 22:39:44 +00:00
server = /usr/local/sbin/saned
2008-02-14 01:57:19 +00:00
}
2013-10-01 02:17:11 +00:00
< / PRE >
< H2 > SYSTEMD CONFIGURATION< / H2 > < PRE >
2022-01-19 20:53:37 +00:00
< B > saned< / B > can be compiled with explicit < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > support. This will allow
2021-02-14 12:22:49 +00:00
logging debugging information to be forwarded to the < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > jour-
nal. The < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > support requires compilation with the systemd-devel
2022-01-19 20:53:37 +00:00
package installed on the system. This is the preferred option.
2008-02-14 01:57:19 +00:00
2021-02-14 12:22:49 +00:00
< B > saned< / B > can be used with < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > without the < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > integration
compiled in, but then logging of debug information is not supported.
2017-05-22 22:39:44 +00:00
2021-02-14 12:22:49 +00:00
The < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > configuration is different for the 2 options, so both
are described below.
2017-05-22 22:39:44 +00:00
< / PRE >
< H2 > Systemd configuration for saned with systemd support compiled in< / H2 > < PRE >
2021-02-14 12:22:49 +00:00
For < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > configuration we need to add 2 configuration files in
2022-01-19 20:53:37 +00:00
< I > /etc/systemd/system< / I > .
2017-05-22 22:39:44 +00:00
2020-03-29 05:47:02 +00:00
The first file we need to add here is called < I > saned.socket.< / I > It shall
2013-10-01 02:17:11 +00:00
have the following contents:
[Unit]
Description=saned incoming socket
[Socket]
ListenStream=6566
Accept=yes
MaxConnections=1
[Install]
WantedBy=sockets.target
2020-03-29 05:47:02 +00:00
The second file to be added is < I > saned@.service< / I > with the following con-
2013-10-01 02:17:11 +00:00
tents:
[Unit]
Description=Scanner Service
Requires=saned.socket
[Service]
ExecStart=/usr/sbin/saned
User=saned
Group=saned
StandardInput=null
StandardOutput=syslog
StandardError=syslog
2017-05-22 22:39:44 +00:00
Environment=SANE_CONFIG_DIR=/usr/local/etc/sane.d
# If you need to debug your configuration uncomment the next line and
# change it as appropriate to set the desired debug options
# Environment=SANE_DEBUG_DLL=255 SANE_DEBUG_BJNP=5
[Install]
Also=saned.socket
You need to set an environment variable for < B > SANE_CONFIG_DIR< / B > pointing to
2022-01-19 20:53:37 +00:00
the directory where < B > saned< / B > can find its configuration files. You will
2023-02-07 03:22:48 +00:00
have to remove the # on the last line and set the variables for the
desired debugging information if required. Multiple variables can be
set by separating the assignments by spaces as shown in the example
above.
2020-09-02 12:23:54 +00:00
2023-02-07 03:22:48 +00:00
Unlike < B > < A HREF = "xinetd.8.html" > xinetd(8)< / A > < / B > and < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > , < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > allows debugging output from
backends set using < B > SANE_DEBUG_XXX< / B > to be captured. See the man-page for
2021-02-14 12:22:49 +00:00
your backend to see what options are supported. With the service unit
2023-02-07 03:22:48 +00:00
as described above, the debugging output is forwarded to the system
2021-02-14 12:22:49 +00:00
log.
2017-05-22 22:39:44 +00:00
< / PRE >
< H2 > Systemd configuration when saned is compiled without systemd support< / H2 > < PRE >
2023-02-07 03:22:48 +00:00
This configuration will also work when < B > saned< / B > is compiled WITH < B > sys-< / B >
< B > < A HREF = "temd.1.html" > temd(1)< / A > < / B > integration support, but it does not allow debugging informa-
2022-01-19 20:53:37 +00:00
tion to be logged.
2017-05-22 22:39:44 +00:00
2023-02-07 03:22:48 +00:00
For < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > configuration for < B > saned< / B > , we need to add 2 configuration
2022-01-19 20:53:37 +00:00
files in < I > /etc/systemd/system< / I > .
2017-05-22 22:39:44 +00:00
2020-03-29 05:47:02 +00:00
The first file we need to add here is called < I > saned.socket.< / I > It is iden-
2023-02-07 03:22:48 +00:00
tical to the version for < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > with the support compiled in. It
2017-05-22 22:39:44 +00:00
shall have the following contents:
[Unit]
Description=saned incoming socket
[Socket]
ListenStream=6566
Accept=yes
MaxConnections=1
[Install]
WantedBy=sockets.target
2023-02-07 03:22:48 +00:00
The second file to be added is < I > saned@.service< / I > . This one differs from
2022-01-19 20:53:37 +00:00
the version with < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B > integration compiled in:
2017-05-22 22:39:44 +00:00
[Unit]
Description=Scanner Service
Requires=saned.socket
2013-10-01 02:17:11 +00:00
2017-05-22 22:39:44 +00:00
[Service]
ExecStart=/usr/sbin/saned
User=saned
Group=saned
StandardInput=socket
2013-10-01 02:17:11 +00:00
2017-05-22 22:39:44 +00:00
Environment=SANE_CONFIG_DIR=/etc/sane.d
[Install]
Also=saned.socket
2008-02-14 01:57:19 +00:00
< / PRE >
< H2 > FILES< / H2 > < PRE >
< I > /etc/hosts.equiv< / I >
2023-02-07 03:22:48 +00:00
The hosts listed in this file are permitted to access all local
SANE devices. Caveat: this file imposes serious security risks
2008-02-14 01:57:19 +00:00
and its use is not recommended.
2017-05-22 22:39:44 +00:00
< I > /usr/local/etc/sane.d/saned.conf< / I >
2023-02-07 03:22:48 +00:00
Contains a list of hosts permitted to access local SANE devices
2008-02-14 01:57:19 +00:00
(see also description of < B > SANE_CONFIG_DIR< / B > below).
2017-05-22 22:39:44 +00:00
< I > /usr/local/etc/sane.d/saned.users< / I >
2008-02-14 01:57:19 +00:00
If this file contains lines of the form
user:password:backend
2023-02-07 03:22:48 +00:00
access to the listed backends is restricted. A backend may be
listed multiple times for different user/password combinations.
2010-02-10 15:23:52 +00:00
The server uses MD5 hashing if supported by the client.
2008-02-14 01:57:19 +00:00
< / PRE >
< H2 > ENVIRONMENT< / H2 > < PRE >
< B > SANE_CONFIG_DIR< / B >
This environment variable specifies the list of directories that
2022-01-19 20:53:37 +00:00
may contain the configuration file. On *NIX systems, the direc-
tories are separated by a colon (`:'), under OS/2, they are sep-
2023-02-07 03:22:48 +00:00
arated by a semi-colon (`;'). If this variable is not set, the
configuration file is searched in two default directories:
first, the current working directory (".") and then in
< I > /usr/local/etc/sane.d< / I > . If the value of the environment variable
ends with the directory separator character, then the default
directories are searched after the explicitly specified directo-
ries. For example, setting < B > SANE_CONFIG_DIR< / B > to "/tmp/config:"
would result in directories < I > tmp/config< / I > , < I > .< / I > , and
< I > /usr/local/etc/sane.d< / I > being searched (in this order).
2008-02-14 01:57:19 +00:00
< / PRE >
< H2 > SEE ALSO< / H2 > < PRE >
2010-02-10 15:23:52 +00:00
< B > < A HREF = "sane.7.html" > sane(7)< / A > < / B > , < B > < A HREF = "scanimage.1.html" > scanimage(1)< / A > < / B > , < B > < A HREF = "xscanimage.1.html" > xscanimage(1)< / A > < / B > , < B > < A HREF = "xcam.1.html" > xcam(1)< / A > < / B > , < B > < A HREF = "sane-dll.5.html" > sane-dll(5)< / A > < / B > ,
2022-01-19 20:53:37 +00:00
< B > < A HREF = "sane-net.5.html" > sane-net(5)< / A > < / B > , < B > sane-"backendname"< / B > (5), < B > < A HREF = "inetd.8.html" > inetd(8)< / A > < / B > , < B > < A HREF = "xinetd.8.html" > xinetd(8)< / A > < / B > , < B > < A HREF = "systemd.1.html" > systemd(1)< / A > < / B >
2008-02-14 01:57:19 +00:00
< I > http://www.penguin-breeder.org/?page=sane-net< / I >
< / PRE >
< H2 > AUTHOR< / H2 > < PRE >
David Mosberger
2020-03-29 05:47:02 +00:00
29 Sep 2017 < B > < A HREF = "saned.8.html" > saned(8)< / A > < / B >
2008-02-14 01:57:19 +00:00
< / PRE >
< HR >
< ADDRESS >
Man(1) output converted with
< a href = "http://www.oac.uci.edu/indiv/ehood/man2html.html" > man2html< / a >
< / ADDRESS >
< / BODY >
< / HTML >
