New build path variable
[freeradius.git] / doc / rlm_sim_triplets
1
2                 SIM Triplets 
3
4 INTRODUCTION
5
6   The module rlm_sim_files reads challenges/responses for use by the
7 EAP-SIM method. This module is a reference implementation for what someone
8 might do via a database or other system.
9   It provides for authorization only.
10
11 RADIUSD.CONF
12
13   To configure this module, list is in modules.
14   An optional option to set the file name exists, it otherwise defaults to
15 ${raddbdir}/simtriplets.dat.
16
17   e.g: in radiusd.conf, modules {},
18
19      sim_files {
20              simtriplets = "/some/file"
21      }
22
23
24   in radiusd.conf, authorize {}, add:
25      sim_files 
26
27   before eap.
28
29 SIMTRIPLETS.DAT:
30
31   The format of the file is one triplet per line, with the userid, aka
32 "imsi" first. Lines starting with # are considered comments.
33  
34   imsi,challenge,kc,sres
35
36   for example:
37
38 232420100000015,34000000000000000000000000000000,34112233,445566778899AABB
39
40   Types
41
42         imsi            - just a string
43         challenge       - 16-byte value in hex.
44         sres            - 4-byte value in hex, the secure response
45         kc              - 8-byte value in hex, the client key (Kc)
46
47   Note that EAP-SIM requires *three* sets of triplets, so there must be
48 three challenges found in the file. The first three challenges are used.
49   Also note that the "0x" for hex is not required, and is illegal.
50   Space and tabs are not permitted.
51
52 AUTHORIZATION
53  
54   Note, if the NAS continues to send the User-Name attribute in subsequent
55 access-requests (such as continuations of the EAP-sim protocol), then the
56 authorization process will be repeated.
57   EAP-sim will capture the first set of attributes, so if they change, that
58 is okay.
59
60   A future version of this module may look at the presence of the EAP-Identity
61 attribute to determine if attributes must be retrieved.
62   However, in the general case, one might not know one wants to even do the
63 EAP-Start to ask for the identity, until one has seen the username.
64
65   If this module is successful at retrieving three sets of triplets, then
66 the EAP-Type: attribute will be set to SIM. The EAP module itself will set
67 the Auth-Type to EAP when it sees the EAP-Message attribute.
68
69   See rlm_eap for details about the attributes used in EAP-sim.
70
71 $Id$
72
73
74
75
76