NTAuth Manual
Configuration options
Setting |
Default |
user_group |
<UID> |
user_workarea |
/ntauth |
loglevel |
info |
debug |
false |
domain |
|
user_group: The name of the group that new users are added to. This group
MUST have the "logon as a batch job" privilege.
user_workarea: The base directory where user files are created, these files
are created in hashed directories, one file per user.
loglevel: The amount of data to log, error logs only errors, info logs
errors and info, debug logs everything.
debug: If set to "true" has same effect as "loglevel debug".
domain: The domain name, if set this domain name is appended to all
usernames returned by all the commands. It is NOT appended to
usernames added to the system.
Command Line Options
-path Tells NTAuth where to create it's logfile and where to find it's
config file.
-debug Sets the logging level to debug.
Supported Commands
Command |
Parameters |
check |
<user> <pass> |
lookup |
<user> |
set |
<user> <pass>|(NULL) [label="value"] |
del |
<user> |
search |
<string> [-from n] [-max m] |
version |
|
help |
|
quit |
|
exit |
|
check Verifies user <user> has password <pass>, this command also
returns the users uid and any information stored for them.
lookup Verifies the existance of user <user> and returns uid and info
as check command above does.
set Add new user or modify an existing user. The special case (NULL)
is used to modify a users info without re-setting the password.
The optional info for a user can be anything provided then info
label contains no spaces or quotes and the value contains no
quotes. NTAuth stores the info in the user_workarea directory.
del Deletes a user and their info stored in user_workarea.
search Returns a list of users matching the search <string>, the string
may contain a * or ? wildcard, if it does the string is matched
as if it was a wildcard string, otherwise a match is found only
if the username contains the string.
version Returns the version number.
help Returns the above list of commands
quit Ends session
exit Ends session
Command Responses
A command will usually respond with a one line response, that response will
start with +OK or -ERR, example:
+OK User test@domain.com created successfully
-ERR Failed to create test@domain.com.
If a command wants to return more that one line as a response it will send
lines starting with +DATA before the final +OK or -ERR response, example:
+DATA test@domain.com config 111
+DATA test2@domain.com config 112
+OK Search Complete 2 items found out of 80
If UnixAuth has a fatal error while trying to initialise then it will return
a -DEAD message like the following...
-DEAD Failed to load config settings, access denied
If you have any questions about NTAuth please don't hesitate to contact:
support-netauth@netwinsite.com