%entities;
]>
uid_credentials
7
&MYSQL_TABLE_TYPE;
Credentials table maps credentials, identified by username and realm to
users identified by uid. Credentials can be used in digest authentication
in SIP and/or authentication in SERWeb. In most situations credentials for
digest authentication and SERWeb authentication are same. There are cases,
however, where seperate credentials for SERWeb and separate credentials
for digest authentication may be needed. One such example are setups where
subscribers get HW user agents with locked configuration and thay do not
know the password and are not allowed to change it. If they should be able
to authenticate in SERWeb then they need different credentials with
different password.
id
unsigned int
&table_id_len;
int,auto
Unique ID
auth_username
string
&user_len;
Credentials username. In digest authentication this is the username
configured in user agents, in SERWeb this is the login username.
did
string
&id_len;
_default
DID of the virtual domain the username belongs to.
realm
string
&realm_len;
Credentials realm. In digest authentication this is the value of digest
realm attribute, in SERWeb this is the part after @ in login username.
password
string
28
Plain text password of the subscriber, can be used for both digest (SER)
and SERWeb authentication.
flags
int
0
Flags that identify where this particular instance of credentials can be
used. If FOR_SER flag is set then the credentials can be used in digest
authentication in SIP. If FOR_SERWEB is set then the credentials can be
used for authentication in SERWeb. Meaning of flags is summarized in the
table below.
Note that several flags below have no meaning in this table and are
only presented for completeness, because the flags column has
identical meaning of flags across most tables in the database.
possible credentials flags
Bit
Hex value
Flag
Description
0
0x00000001
FOR_SER
If set then SER will load the row (not applicable in this
table).
1
0x00000002
DISABLED
The data represented by the row is temporarily disabled, which
means it stays in the database but no applications use it.
2
0x00000004
CANONICAL
The URI or domain name is canonical. When displaying the URI
of the user or name of a domain then this entry should be
used. Not applicable in this table.
3
0x00000008
ALLOWED_TO
The URI represented by this row can be used in The Request-URI
or To header field. In other words the user will be reachable
under this URI and can use it as an alias. Not applicable in
this table.
4
0x00000010
ALLOWED_FROM
The user identified by uid can use this URI in From header
field. Not applicable in this table.
5
0x00000020
FOR_SERWEB
The data represented by the row is for SERWeb. This is
currently used in credentials table only where the flags
allows to keep different credentials for digest authentication
in SIP and for SERWeb authentication. Not applicable in this
table.
6
0x00000040
PENDING
The account owning the piece of data has not been activated
yet. Not applicable in this table, this is mainly used in
credentials table.
7
0x00000100
DELETED
The row has been scheduled for deletion.
8
0x00000200
CALLER_DELETED
The accounting record has been scheduled for deletion by the
caller. The row can be deleted once both the caller and callee
schedule the record for deletion. A single record can be
shared by two users and thus both of them must schedule it for
deletion before it can be physically deleted.
9
0x00000400
CALLEE_DELETED
The accounting record has been scheduled for deletion by the
callee. The row can be deleted once both the caller and callee
schedule the record for deletion. A single record can be
shared by two users and thus both of them must schedule it for
deletion before it can be physically deleted.
ha1
string
32
For digest authentication only. This is the H(A1) value calculated as
per RFC2617. The value contains an MD5 hash of string concatenated from
username,realm, and password: MD5(username:realm:password).
ha1b
string
32
Similar to ha1, but username@domain is used as username. This is
necessary for user agents that put username@domain into digest username
attribute. This is often useful in multi-domain setups because it allows
users to explicitly specify the domain they wish to sign in.
uid
uuid
string
&id_len;
This is the UID (User ID) identifier of the user the credentials are
assigned to. Each uid can have multiple credentials assigned. UIDs of
subscribers with no credentials assigned do not appear in this table.
cred_idx
uid
uuid
did_idx
realm_idx