1eurephia-auth(7)                                              eurephia-auth(7)
2
3
4

NAME

6       eurephia-auth - The eurephia OpenVPN authentication plug-in
7

DESCRIPTION

9       The eurephia-auth.so is a plug-in for OpenVPN.  It is loaded by provid‐
10       ing the --plugin option in the OpenVPN configuration.
11
12       The syntax for OpenVPN and eurephia-auth is:
13
14              plugin eurephia-auth.so "<plugin args> -- <DB args>"
15
16       Please notice the quotes and the double dash.  They are important mark‐
17       ers  so  that  the  eurephia-auth  module  receives  all arguments (the
18       quotes) and that it knows when to pass on the rest of the arguments  to
19       the defined database driver, separated by the double dash.  This manual
20       page will only look at the <plugin args> options.  For  the  <DB  args>
21       options, refer to the corresponding database driver you are using.
22
23

OPTIONS

25       --log-destination | -l
26              This  defines  how  eurephia  will do its logging. It can take a
27              filename to log to a file. If the string  is  openvpn:  it  will
28              pass  the log data over to OpenVPN, which will combine the Open‐
29              VPN and eurephia logs. You can also log via syslog, by  indicat‐
30              ing syslog:. The last possible special value is none: which will
31              disable logging completely.
32
33              With syslog: you can also define which syslog facility the  log‐
34              ging  will  go  to.  The default is to log to the user facility.
35              Other supported facilities are authpriv, daemon  and  local0  to
36              local7.  To  send  log  data to the daemon the --log-destination
37              argument need to be
38
39                  --log-destination syslog:daemon
40
41       --log-level | -L
42              This defines how verbose  the  eurephia  logging  will  be.  The
43              required  argument to this option must be a numeric value, where
44              0 indicates as little logging as possible - only giving informa‐
45              tive  messages,  or  a high value like 50 to give really verbose
46              logging. In general a log level less than 4 should be more  than
47              enough under normal circumstances.
48
49              NOTICE:  The  highest  log level is 10, unless the eurephia-auth
50              modules have been compiled with debug features.
51
52       --database-interface | -i
53              This argument must have a full path  to  the  eurephia  database
54              driver  module.  This  defines which database interface eurephia
55              will use.
56

OPENVPN CLIENTS

58       The only change the OpenVPN clients needs to do is to add
59
60              auth-user-pass
61
62       to their configuration file.  This instructs the OpenVPN client to  ask
63       for user name and password when starting the connection.
64

SEE ALSO

66       eurephia-sqlite(8), eurephia_init(8)
67

AUTHOR

69       Copyright (C) 2008-2010  David Sommerseth <dazo@users.sourceforge.net>
70
71
72
73David Sommerseth                   July 2010                  eurephia-auth(7)