MorphoAccess Parameters Guide
MorphoAccess Parameters Guide
Parameters Guide
November 2009
Table of Contents
REVISIONS HISTORY
PARAMETER MODIFICATION
NOTATION
[SECTION IN CONFIGURATION FILE]
SSL SECURING CONFIGURATION KEYS
WI-FI CONFIGURATION KEYS
DESFIRE CONFIGURATION KEYS
9
9
9
9
10
10
11
[BIO CTRL]
[CONTACTLESS]
[RELAY]
[SEND ID UDP]
[SEND ID ETHERNET]
[TAMPER ALARM]
[SEND ID W IEGAND]
[SEND ID DATACLOCK]
[SEND ID SERIAL]
[FAILURE ID]
[LOG FILE]
[LED IN]
[G.U.I]
[MODES]
[DATACLOCK IN] (MORPHOACCESS 500 SERIES ONLY)
[W IEGAND IN] (MORPHOACCESS 500 SERIES ONLY)
[INFO]
[KEYBOARD] (MORPHOACCESS 500 SERIES ONLY)
11
15
18
18
18
20
20
23
24
25
26
27
27
28
30
30
31
31
33
[BIO CTRL]
33
34
34
34
35
SSE-0000062458-05
35
37
[BOOT PROTO]
[PARAMETERS]
[DEVICE]
37
37
37
38
[MISCELLANEOUS]
[PROFILE0]
[PROFILE1]
38
38
40
42
42
44
[INIT STATE]
[SW ITCH APP]
44
44
45
45
46
47
48
[CONTACTLESS]
48
49
[LOGPARAM]
[SYNCHRO]
49
50
51
[INTERFACES]
51
SSE-0000062458-05
EVENTS (EVENTS.CFG)
52
[GENERAL]
[BIO_CHG]
[LOG_FULL]
52
52
53
SUPPORT
54
CUSTOMER SERVICE
HOTLINE
54
54
SSE-0000062458-05
REVISIONS HISTORY
Date
July 08
Firmware
Description
All
2.07
2.09
June
2009
2.10
October
2009
2.11
SSE-0000062458-05
Biometrics
MA 500+
Series
OMA 500
Series
MA 500
Series
Contactless Smartcard
Reader
MIFARE
DESFire
MA 500+
MA 520+ D
MA 521+ D
OMA 520 D
OMA 521 D
OMA 520
OMA 521
MA 500
MA 520
MA 521
False
Finger
Detection
Outdoor
SSE-0000062458-05
MA 100
Series
SSE-0000062458-05
MIFARE
MA 100
MA 110
MA 120
MA 120 D
DESFire
[log file]
enabled=1
[log file]
enabled=bo(e)
SSE-0000062458-05
Parameter modification
There are two main ways to modify a parameter.
<<
>>
EXIT
Notation
The notation below is employed:
10
SSE-0000062458-05
SSE-0000062458-05
11
Description
in] section.
2
section.
authent timeout 10 [1-60] (only in MorphoAccess 500 Series, and
MorphoAccess 100 Series terminals equipped with a contactless
smartcard reader)
Defines (in seconds) the delay given to the user to place a finger on the
sensor, after user ID acquisition: read on users contactless card, seized
on the keyboard (MorphoAccess 500 Series only), or received through
Wiegand/DataClock port (MorphoAccess 500 Series only).
BIOPIN enabled 0 (0, 1) (only in MorphoAccess 500 Series
equipped with a contactless smartcard reader)
This feature allows replacing normal biometric check, by a numeric code
(BIOPIN) check. This is an option of authent PK contactless mode, and it
requires that the contactless card contains a BIOPIN code (tag BIOPIN),
and no templates (neither tag PK1, nor tag PK2).
As this check is an option, the key authent PK contactless must be set
to 1.
12
SSE-0000062458-05
Description
FINGER
CARDDATA
KBD
SSE-0000062458-05
13
Identifier type
Description
WGDTCLK
CARDSN:STD
CARDSN:REV
NOTE:
Priority example:
On a MorphoAccess 520, the key AC_ID is set to:
FINGER;CARDDATA;CARDSN:STD;KBD;WGDTCLK;
The user presents a MIFARE card containing two templates and a user
ID stored in TLV format. It is assumed that the MorphoAccess 520 has
the relevant MIFARE authentication keys (it means that the data stored
on the card can be read by the terminal):
14
SSE-0000062458-05
the CARDDATA condition is satisfied because there is a user ID
stored in the contactless card, and its value can be read by the
terminal,
so, the access control process uses the Card UID (bytes read in
direct order) because the CARDSN:STD is the only one condition
satisfied.
[contactless]
This section applies only to MorphoAccess equipped with a contactless
smart card reader.
C 1 (1, 2, 3)
1: Key A then B are presented to read a MIFARE card.
2: Key A only.
3: Key B only.
B 4 [0-215]
First block read on MIFARE cards.
data format 0 (0, 1)
When this feature is activated, the identifier is read at a given offset
(defined by data offset) on the card and is supposed to be binary.
This mode can not be used when card profile reading is configured.
data offset 0.0 [number of bytes].[additional bits]
Defines the offset in the read block defined by B.
data length 8.0 [number of bytes].[additional bits]
ID size in bytes, with possible additional bits.
SSE-0000062458-05
15
None.
This value disables all authentication modes based on a
contactless card (all contactless cards are ignored).
SSE-0000062458-05
The key enables cards reading profiles. This key is a bit field:
Value Enabled profiles
0
No profile is enabled.
If card reading is set by the standard existing registry keys (see
above). MIFARE card reading is enabled.
SSE-0000062458-05
17
16
[relay]
aperture time in 10ms 300 [50-60000]
The relay aperture time can be defined with this parameter.
enabled 1 (0, 1)
Activates the relay after a successful control during the previous time.
relay default state 0 (0, 1)
Defines the relay default state (when access is not authorized).
external control by LED1 0 (0,1)
The relay is switched during the previous time, when LED1 is set to the
ground, otherwise it remains in the default state. (This functionality is
not compatible with the LED IN functionality)
[send ID UDP]
host name 134.1.2.189 (IP address only)
Defines the IP address of the host that will receive the user ID messages.
host port 11020 [0-65535]
Defines the host port on which the user ID messages are sent.
enabled 0 (0, 1)
Activates the sending of user ID messages (access control check result),
thought IP link, using UDP protocol.
[send ID ethernet]
connect timeout 2000 ([1-65000]
Timeout used for connection, reading and writing data (at TCP/UDP level)
to/from the remote controller. This timeout is a multiple of 10 ms (2000
means 20 seconds).
18
SSE-0000062458-05
Not used.
19
If enabled, the terminal will try to connect to the remote controller using
SSL. Note that both the terminal and the controller must be able to
communicate and authenticate themselves (requires certificates).
[tamper alarm]
level 0 (0, 1, 2)
Value Description
0
[send ID wiegand]
valid format 1 (0,1) (read only)
The frame format, as specified by the configuration keys below, is valid.
custom format 0.0 (do not edit)
Reserved for Sagem Scurit custom protocols.
ID format 9.16 (n.m)
Inserts m bits of ID value at offset n (first bit is n=0, m 64).
site format 1.8 (n.m)
Inserts m bits of site value at offset n (first bit is n=0, m 64).
stop format 3.12 (0.0, 1.0, 2.n, 3.n, 4.0)
Defines the stop control bit format. Refer to MorphoAccess Remote
Messages Specification document.
start format 2.12 (0.0,1.0, 2.n, 3.n, 4.0)
Defines the start control bit format. Refer to MorphoAccess Remote
Messages Specification document.
20
SSE-0000062458-05
SSE-0000062458-05
21
Example:
The administrator wants the MorphoAccess to match the MIFARE
contactless card UID and send it using the Wiegand output with no site
code, no start bit, and no stop bit. He also wants to send an alarm ID in
case of back cover removal.
The key /app/bio ctrl/AC_ID is configured to match the contactless card
UID.
Alarm keys are correctly configured.
22
SSE-0000062458-05
[send ID dataclock]
data inverted 0 (0, 1)
Data level is inverted.
clock inverted 0 (0, 1)
Clock level is inverted.
enabled 0 (0, 1)
Allows the sending of the User ID message (result of access control
check) using DataClock protocol (the Send ID Wiegand feature must be
disabled).
card present signal 0 (0, 1) (MorphoAccess 500 Series only)
Activates the card present signal. The card present pin is set to 5V when
the ID is sent on the dataclock pins, and reset to 0V when the
transmission is finished. It is useful for some dataclock controllers.
NOTE: At the terminals startup, the signal is set to 5V during less than
1s then it is set to 0V.
SSE-0000062458-05
23
[send ID serial]
mode 485 (422, 485)
Defines the serial protocol to use.
Value Description
485
422
24
SSE-0000062458-05
[failure ID]
send ID mask 255 [0-255] (only for send ID Ethernet modes)
This bit field mask defines which kind of ID messages are sent, when one
of the send ID Ethernet modes is enabled
Value Description
255
16
128
For example to send only the user ID message when the user is
authorized and when user is not recognized, set this key to 3, which
means 1 (User authorized message) + 2 ( User not recognized or not
authorized message).
The configurations keys listed below, apply only to the Send ID
Wiegand and to the Send ID DataClock features. These keys
specify the value to send for each case of access denied reason.
not on time ID 65535 [0-65535]
Value to send if the access is denied during the current time area (Time
Mask feature).
timeout ID 65535 [0-65535]
Value to send if the access is denied because timeout occurs during
access control check.
not in DB ID 65535 [0-65535]
Value to send if the access is denied because no record can be found in
the database for the specified user ID (i.e. no biometric operation can be
performed).
not recognized ID 65535 [0-65535]
Value to send if the access is denied because the user is not identified
(i.e. a biometric operation has failed).
SSE-0000062458-05
25
[log file]
enabled 1 (0, 1)
When set to 1, the key activates the recording of each access control
request in the internal log file.
full handling 00000000
This string represents a bit field. It defines the actions to perform when the
access control logs are full in a MorphoAccess terminal. To enable an
action, set the corresponding bit to 1 in value of the configuration key.
Value
Description
00000000
Nothing is performed
00000001
00000002
00000004
The actions can be combined by combining the value. For example, set
the value to 00000003 to display a warning message and send a
message to a distant computer.
26
SSE-0000062458-05
[led IN]
controller ack timeout 300 [0-3000]
LED IN acknowledgement timeout in 10 ms. If no signal is detected (from
LED1 or LED2) within the specified time, the terminal denies the access to
the user.
enabled 0 (0, 1)
When set to 1, the terminal wait for a signal on LED1 (access granted) or
on LED2 (access denied), to return the final result of access control
request to the user.
[G.U.I]
database conversion 500 [300, 500] (MorphoAccess 500 Series
only)
300: 16 databases mode (for MA300 compatibility).
500: 5 databases mode.
display user info 2 [0 2] (MorphoAccess 500 Series only)
2: if database contains additional fields FNAME and NAME user name
and first name are displayed on successful recognition.
1: user identifier is displayed on successful recognition.
0: no personal information is displayed on successful recognition.
default language 0 [0-5] (MorphoAccess 500 Series only)
Defines the user interface language. 0 for English.
volume 10 [0-10]
0: The buzzer is off.
[1-10]: The volume is set to the corresponding value. 10 is the maximum
volume.
led out signal 0 (0, 1) (MorphoAccess 500 Series only)
Activates the led out signal. The led out pin is the copy of the multicolour
LED in case of positive match. It means that signal is set to 5V when the
led is on and set to 0V the rest of the time.
NOTE: At the startup of the terminal, the signal is set to 5V during a
very short period of time then it is set to 0V.
display hour 0 (0, 1) (MorphoAccess 500 Series only)
Displays hour and date on the main screen.
SSE-0000062458-05
27
[modes]
time and attendance 0 (0, 1, 2, 3) (MorphoAccess 500 Series only)
Time and attendance mode can be activated with 2 (option 1) or 4 buttons
(option 2).
When the value is set to 3, the extended time and attendance is activated:
each numeric key of the keyboard is associated to one of the time and
attendance function (described in the app/keyboard/mapping
configuration key), and a customer designed bitmap picture is displayed
on the terminals screen. Usually, this picture indicates the assignation of
each key.
T&A operation timeout 20 (0-65535) (MorphoAccess 500 Series
only)
This value specifies the Time and Attendance timeout (value is in
seconds). This is the timeout after which the operation in progress is
cancelled and the MorphoAccess comes back to the Time and
Attendance main screen.
time mask 0 (0, 1)
This mode enables the access according to its time mask. Time mask is
defined by slots of 15 minutes over a week. Database must contain an
additional field TMSK.
28
SSE-0000062458-05
SSE-0000062458-05
29
30
SSE-0000062458-05
[info]
type (read only)
Terminal type (MA100, MA110, )
release A (read only)
For internal use only.
minor Y (read only)
Minor software revision.
major X (read only)
Major software revision.
SSE-0000062458-05
31
Code
1
'2'
'3'
'4'
'5'
'6'
'7'
'8'
'9'
Code
1
Out
Temporary In
Temporary Out
Key code
The four first functions are identical to the one supported by the 4 buttons
Time and Attendance mode (activated when the app/modes/time and
attendance key is equal to 2).
The key code function is specific to the extended Time and Attendance
mode: in the access check result message sent through IP, the letter
which identifies the In/Out function is replaced by corresponding digit of
the pressed function key (if the 3 key is pressed, then the message
contains 3 in Time and Attendance field).
32
SSE-0000062458-05
Following keys are strictly reserved for Sagem Scurit use only.
Please do not change their values, the actual values are tuned to
obtain the best results:
uniformity correction 0
image contrast 0
image size 0
sensor sensibility 1
1st try strategy 0
2nd try strategy 1
presence detection 0
SSE-0000062458-05
33
34
SSE-0000062458-05
[distant session]
inactivity timeout 6000 [0-6000]
Duration let to a remote host to send another following command before
reactivating the terminals default running state (as biometric sensor for
identification).
Please do not change this value, the actual value is tuned to obtain
the best result.
Duration let to SSL server to send command frames (in case of big
frames).
Please do not change this value, the actual value is tuned to obtain the
best result.
command read timeout [20] (SSL use only)
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Duration let to SSL server to receive command frames (in case of big
frames).
Please do not change this value, the actual value is tuned to obtain the
best result.
profile id [0-1] (SSL use only)
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
35
If enabled (default and only available value), session cache will be used.
Must not be disabled.
port 11010 [0-65535] (SSL use only)
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
If enabled, SSL server will start then wait for commands. If TCP server
and SSL server are enabled with same listening port, priority will be given
to TCP. It is recommended to use Sagem Scurits Active MACI as
remote SSL client communication layer.
36
SSE-0000062458-05
[parameters]
network mask 255.255.240.0
Static network mask (reboot is mandatory).
default gateway 134.1.6.20
Static default gateway (reboot is mandatory).
network address 134.1.32.214
Static IP address (reboot is mandatory).
host name MA061110008
Hostname for DHCP (reboot is mandatory).
[device]
speed 10 (10, 100)
Ethernet device speed (Mbits/s) (reboot is mandatory).
SSE-0000062458-05
37
[profile0]
This section is commonly used to define the SSL profile for the SSL server
(refer the ADM / Remote management SSL).
retry connection timeout [1]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
connection timeout [0]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
write timeout [50]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
read timeout [50]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
retry init timeout [1]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
init timeout [0]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
38
SSE-0000062458-05
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
list name
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Algorithm strength level. Other values are reserved for a future use.
supported cipher [00250021]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Supported cipher mask. Other values are reserved for a future use.
protocol version[2]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Value 2 means SSL version 3. Other values are reserved for a future use.
Name
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
39
[profile1]
This section is commonly used to define the SSL profile for the SSL client
(refer the APP / Send ID Ethernet).
retry connection timeout [1]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
connection timeout [0]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
write timeout [50]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
read timeout [50]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
retry init timeout [1]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
init timeout [0]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Internal value. Must not be modified. Modifying this could turn the terminal
in a non working state.
list name
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
SSE-0000062458-05
Algorithm strength level. Other values are reserved for a future use.
supported cipher [00250021]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Supported cipher mask. Other values are reserved for a future use.
protocol version [2]
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
Value 2 means SSL version 3. Other values are reserved for a future use.
name
Do not change this key manually. Please read section SSL securing configuration
keys at the beginning of this document.
SSE-0000062458-05
41
presses the Cancel Key (Red function key), the terminal return to
Time and Attendance main screen (key selection),
presses the Validation Key (Green function key), the terminal goes
immediately to next step (usually biometric check),
does not press any key: when the time-out value is reached, the
terminal goes automatically to next step (same as Validation Key
pressure).
42
SSE-0000062458-05
[MMI definition]
buzzer 0;0;0;0;0;0
Strictly reserved for Sagem Scurit use only.
led 0;0;0;0
Strictly reserved for Sagem Scurit use only
priority 200
Strictly reserved for Sagem Scurit use only
number 3
Strictly reserved for Sagem Scurit use only
SSE-0000062458-05
43
Description
MACCESS application
Enrolment application
[switch app]
app. number 1
Strictly reserved for Sagem Scurit use only.
44
SSE-0000062458-05
0 for none
1 for WEP64
2 for WEP128
authentication method
Do not change this key manually. Please read section Wi-Fi configuration keys at
the beginning of this document.
channel
Do not change this key manually. Please read section WI-FI configuration keys at
the beginning of this document.
signal strength
Do not change this key.
SSE-0000062458-05
45
[profile: YYY]
This section is commonly used to define a profile corresponding to a valid
and reachable access point.
SSID
Do not change this key manually. Please read section WI-FI configuration keys at
the beginning of this document.
key
Do not change this key manually. Please read section WI-FI configuration keys at
the beginning of this document.
46
SSE-0000062458-05
[properties]
active profile
Do not change this key manually. Please read section WI-FI configuration keys at
the beginning of this document.
Description
network address
Do not change this key manually. Please read section WI-FI configuration keys at
the beginning of this document.
SSE-0000062458-05
47
[contactless]
encode type (Terminals equipped with a DESFire contactless
smartcard reader only)
This key let the user select the type of card he can encode using the
enrolment application.
Value Encode cards:
1
DESFire
MIFARE
48
SSE-0000062458-05
Description
SSE-0000062458-05
49
[Synchro]
SynchroKey
Do not change this key manually.
50
SSE-0000062458-05
Type
Parameters
IP
SSE-0000062458-05
51
EVENTS (EVENTS.CFG)
[general]
active FFFFFFFF
This string key is used as a bit field that defines the events that can
generate a message sending.
Value
Description
00000001
00000002
[bio_chg]
That section is available only if the active key allows it.
nb sending 0 (0-255)
This key defines the number of sending performed when the administrator
decides to signal biometric databases changes to a distant host.
sendX
That configuration key is created only if nb sending is more than 0.
It defines one sending. A sending is defined by the number of attempts,
the attempt interval, a response needed flag, and an interface (cf.
[interfaces])
The configuration key value has the following format:
<Nb attempt>;<Attempt interval in seconds>;<Response needed 0-1
>;<Interface>;
Each parameter is separated by a ;, and the final ; is mandatory.
Example:
3;5;1;int1;
It means that the sending has 3 5s spaced attempts, a response message
is awaited, and the interfaces int1 from the remotemsg file will be used.
52
SSE-0000062458-05
[log_full]
That section is available only if the active key allows it.
nb sending 0 (0-255)
This key defines the number of sending performed when the access
control log file is full.
sendX
That configuration key is created only if nb sending is more than 0.
It defines one sending. A sending is defined by the number of attempts,
the attempt interval, a response needed flag, and an interface (cf.
[interfaces])
The configuration key value has the following format:
<Nb attempt>;<Attempt interval in seconds>;<Response needed 0-1
>;<Interface>;
Each parameter is separated by a ;, and the final ; is mandatory.
Example:
3;5;0;int2;
It means that the sending has 3 5s spaced attempts, no response
message is awaited, and the interfaces int2 from the remotemsg file will be
used.
Please refer to MA500 Series User Guide and MA100 Series User Guide
to know about the messages format.
SSE-0000062458-05
53
SUPPORT
Customer service
Sagem Scurit
SAV Terminaux Biomtriques
Boulevard Lnine - BP428
76805 Saint Etienne du Rouvray
FRANCE
Phone: +33 2 35 64 55 05
Hotline
Sagem Scurit
Support Terminaux Biomtriques
18, Chausse Jules Csar
95520 Osny
FRANCE
[email protected]
Phone: +33 1 58 11 39 19
http://www.biometric-terminals.com/
Copyright 2009 Sagem Scurit
http://www.sagem-securite.com/
54
SSE-0000062458-05