src/modules/rlm_dbm/rlm_dbm_parser.8

   1 .TH RLM_DBM_PARSER 8
   2 .SH NAME
   3 rlm_dbm_parser - transforms simple syntax into rlm_dbm format
   4 .SH SYNOPSIS
   5 .B rlm_dbm_parser
   6 .RB [ \-c ]
   7 .RB [ \-d
   8 .IR raddb ]
   9 .RB [ \-i
  10 .IR inputfile ]
  11 .RB [ \-o
  12 .IR outputfile ]
  13 .RB [ \-x ]
  14 .RB [ \-v ]
  15 .RB [ \-q ]
  16 [\fIusername ...\fP]
  17
  18 .SH DESCRIPTION
  19 \fBrlm_dbm_parser\fP reads a file of the syntax defined below, and writes
  20 a database file usable by rlm_dbm or edits current database.
  21 .PP
  22
  23 .SH INPUT FORMAT
  24
  25 \fIrlm_dbm_parser\fP reads a format similar to the one used by the files
  26 module. In incomplete RFC2234 ABNF, it looks like this:
  27
  28 .nf
  29 entries     = *entry
  30 entry       = identifier TAB definition
  31 identifier  = username / group-name
  32 username    = +PCHAR
  33 groupname   = +PCHAR
  34 definition  = (check-item ",")* LF ( *( reply-item ",") / ";" ) LF
  35 check-item  = AS IN FILES
  36 reply-item  = AS IN FILES
  37 * need definition of username and groupname
  38 .fi
  39
  40 As an example, these are the standard files definitions (files module).
  41
  42 .nf
  43 DEFAULT   Service-Type == Framed-User
  44           Framed-IP-Address = 255.255.255.254,
  45           Framed-MTU = 576,
  46           Service-Type = Framed-User,
  47           Fall-Through = Yes
  48
  49 #except who call from number 555-666
  50 DEFAULT   Auth-Type := Reject,Service-Type ==Framed-User,
  51           Calling-Station-ID == "555-666"
  52
  53 #or call number 555-667
  54 DEFAULT   Auth-Type := Reject,Service-Type ==Framed-User,
  55           Calling-Station-ID == "555-667"
  56 .fi
  57
  58 To be a valid rlm_dbm input file, it should look like this:
  59
  60 .nf
  61 DEFAULT   Service-Type == Framed-User                     # (1)
  62           Framed-IP-Address = 255.255.255.254,            # comma, list cont'd
  63           Framed-MTU = 576,
  64           Service-Type = Framed-User,
  65           Fall-Through =  Yes                             # \\n, end of list
  66           Auth-Type := Reject,Service-Type ==Framed-User, # (2)
  67           Calling-Station-ID == "555-666"
  68           ;                                               # ;, no reply items
  69           Auth-Type := Reject,Service-Type ==Framed-User, # (3)
  70           Calling-Station-ID == "555-667"
  71           ;                                               # ditto
  72 .fi
  73
  74 This user (the DEFAULT user) contains three entries, 1, 2 and 3. The
  75 first entry has a list of reply items, terminated by a reply item
  76 without a trailing comma. Entries 2 and 3 has empty reply lists, as
  77 indicated by the semicolon. This is necessary to separate an empty
  78 line (which is ignored) from the empty list.
  79 Definition Fall-Through = Yes used in order to say module to check next
  80 record. By default Fall-Through = Yes.
  81
  82 .SH OPTIONS
  83
  84 .IP \-d\ \fIraddb\fP
  85 Use \fIraddb\fP as the radiusd configuration directory.
  86 .IP \-i\ \fIinputfile\fP
  87 Use \fIfile\fP as the input file. If not defined then use standard input.
  88 .IP \-o\ \fIoutputfile\fP
  89 Use \fIfile\fP as the output file.
  90 .IP \-c
  91 Create a new database (empty output file before writing)
  92 .IP \-x
  93 Enable debug mode. Multiple x flags increase debug level.
  94 .IP \-q
  95 Do not print statistics (quiet).
  96 .IP \-v
  97 Print the version and exit.
  98 .IP \-r
  99 Remove a username or group name from the database.
 100
 101 .SH SEE ALSO
 102 radiusd(8)
 103 .SH AUTHORS
 104 .TP
 105 Author:
 106 Andrei Koulik <rlm_dbm@agk.nnov.ru>
 107 .TP
 108 Documentation:
 109 Bjørn Nordbø  <bn@nextra.com>