1eurephiadm(7)                                                    eurephiadm(7)
2
3
4

NAME

6       eurephiadm - eurephia administration utility
7

SYNOPSIS

9       eurephiadm  <command>  [-h|--help]  [-V|--version]  [<global  options>]
10       [-l|--log <filename>]  [-L|--log-level  <log  level>]  [<command  argu‐
11       ments>]
12

DESCRIPTION

14       eurephiadm is a generic command line tool for administering and config‐
15       uring the eurephia plug-in for OpenVPN.
16

COMMANDS

18       Available commands in eurephiadm
19
20       help [<command>]
21              This help screen if no arguments are given.   If  a  command  is
22              given, the help screen for that command is provided.
23
24       logout Logout  from  an  active eurephiadm session.  Most of the opera‐
25              tions in eurephiadm requires the user to  authenticate  him/her‐
26              self.   The  session will then be active for a predefined amount
27              of time, not requiring new authentications.  The user will  have
28              to authenticate him/herself again if the session timesout or the
29              logout command is used.
30
31       users [<arguments>]
32              User management module.  Lists, adds, removes, activates,  deac‐
33              tivates  and  shows  user  account information for each eurephia
34              user.
35
36       lastlog
37              Query the eurephia lastlog.  This log contains information about
38              OpenVPN session authenticated via eurephia.
39
40       attempts [<arguments>]
41              Show or reset registered failed login attempts registrations.
42
43       blacklist [<arguments>]
44              Show,  add  or delete blacklisted user accounts, certificates or
45              IP addresses.
46
47       certs [<arguments>]
48              SSL Certificate management for eurephia authentication.
49
50       usercerts [<arguments>]
51              Manages the relations between eurephia user  accounts  and  cer‐
52              tificates.   This  combination  is  called  a  user  access, and
53              defines which access level the authenticated eurephia user  will
54              have to the network.
55
56       fwprofiles [<arguments>]
57              Firewall  profile  management.   Add,  list or delete (iptables)
58              profiles available for eurephia in the operating  system.   This
59              feature  is only available if eurephiadm was compiled with fire‐
60              wall support.
61
62       adminaccess [<arguments>]
63              Manages eurephia user accesses to administration utilities  like
64              eurephiadm.
65
66       show-config
67              List  all  config  settings  set  in  the  database  and  in the
68              ~/.eurephia/eurephiadm.cfg file.
69
70       show-configfile
71              Similar to the show-config command, but lists  only  the  parsed
72              settings in the ~/.eurephia/eurephiadm.cfg file.
73
74       config [<arguments>]
75              Add,  delete  or  show eurephia configuration settings stored in
76              the database.
77

FILES

79       ~/.eurephia/eurephiadm.cfg
80              Default configuration file which defines the database driver and
81              the needed database parameters.
82

CONFIGURATION FILE

84       The  configuration  file  is  a simple key-value based text file, where
85       keys and values are separated by an equal sign ("=").  All text  coming
86       after  a  hash  ("#")  will be ignored and considered as comments.  The
87       variables eurephiadm uses are:
88
89       database_driver
90              Contains a full path to the database driver eurephiadm  need  to
91              use.
92
93       database_params
94              All  database arguments the database driver requires must be set
95              here.  See the man page for the  corresponding  database  driver
96              for more information about valid options.
97
98       log    Defines  how  to  log.  If a file name is given, logging will be
99              sent to this log file.  Other valid values are:
100
101              stderr: or stdout:
102              Logging will go directly to stderr or stdout
103
104              syslog:[local0..local7 | daemon | authpriv]
105              Logging will be sent to syslog.  The default syslog  destination
106              is daemon.
107
108       log_level
109              Sets  the  log verbosity.  Normally the values will be from 0 to
110              10, where 0 is as little logging as possible and 10 is very ver‐
111              bose.   If  eurephiadm  or  the database driver is compiled with
112              debug logging, values up to 50 will be valid.
113
114       username
115              eurephiadm will always be asking for a user  name  when  logging
116              into  the administration application.  By setting this variable,
117              you will set a default user name eurephiadm will use  when  log‐
118              ging in and it will only ask for a password directly.
119

ENVIRONMENT

121       EUREPHIA_DIR
122              The eurephiadm utility looks for a configuration file by default
123              in ~/.eurephia/eurephiadm.cfg.  This directory can be overridden
124              by setting the EUREPHIA_DIR environment variable, and eurephiadm
125              will use the eurephiadm.cfg file in this directory instead.
126

SEE ALSO

128       eurephiadm-users(7),   eurephiadm-lastlog(7),   eurephiadm-attempts(7),
129       eurephiadm-blacklist(7),  eurephiadm-certs(7), eurephiadm-usercerts(7),
130       eurephiadm-fwprofiles(7),  eurephiadm-adminaccess(7),   eurephiadm-con‐
131       fig(7), edb-sqlite(7)
132

AUTHOR

134       Copyright (C) 2008-2012  David Sommerseth <dazo@users.sourceforge.net>
135
136
137
138David Sommerseth                   July 2010                     eurephiadm(7)
Impressum