docs/manpages/ntlm_auth.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "NTLM_AUTH" 1 "" "" ""
  21 .SH NAME
  22 ntlm_auth \- tool to allow external access to Winbind's NTLM authentication function
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBntlm_auth\fR [-d debuglevel] [-l logfile] [-s <smb config file>]
  27 .fi
  28
  29 .SH "DESCRIPTION"
  30
  31 .PP
  32 This tool is part of the \fBSamba\fR(7) suite\&.
  33
  34 .PP
  35 \fBntlm_auth\fR is a helper utility that authenticates users using NT/LM authentication\&. It returns 0 if the users is authenticated successfully and 1 if access was denied\&. ntlm_auth uses winbind to access the user and authentication data for a domain\&. This utility is only to be used by other programs (currently squid)\&.
  36
  37 .SH "OPTIONS"
  38
  39 .TP
  40 --helper-protocol=PROTO
  41 Operate as a stdio-based helper
  42
  43
  44 .TP
  45 --username=USERNAME
  46 Specify username of user to authenticate
  47
  48
  49 .TP
  50 --domain=DOMAIN
  51 Specify domain of user to authenticate
  52
  53
  54 .TP
  55 --workstation=WORKSTATION
  56 Specify the workstation the user authenticated from
  57
  58
  59 .TP
  60 --challenge=STRING
  61 challenge (HEX encoded)
  62
  63
  64 .TP
  65 --lm-response=RESPONSE
  66 LM Response to the challenge (HEX encoded)
  67
  68
  69 .TP
  70 --nt-response=RESPONSE
  71 NT or NTLMv2 Response to the challenge (HEX encoded)
  72
  73
  74 .TP
  75 --password=PASSWORD
  76 User's plaintext password
  77
  78
  79 .TP
  80 --request-lm-key
  81 Retreive LM session key
  82
  83
  84 .TP
  85 --request-nt-key
  86 Request NT key
  87
  88
  89 .TP
  90 -V
  91 Prints the version number for \fBsmbd\fR\&.
  92
  93
  94 .TP
  95 -s <configuration file>
  96 The file specified contains the configuration details required by the server\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
  97
  98
  99 .TP
 100 -d|--debug=debuglevel
 101 \fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
 102
 103
 104 The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out\&.
 105
 106
 107 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
 108
 109
 110 Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
 111
 112
 113 .TP
 114 -l|--logfile=logbasename
 115 File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
 116
 117
 118 .TP
 119 -h|--help
 120 Print a summary of command line options\&.
 121
 122
 123 .SH "VERSION"
 124
 125 .PP
 126 This man page is correct for version 3\&.0 of the Samba suite\&.
 127
 128 .SH "AUTHOR"
 129
 130 .PP
 131 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
 132
 133 .PP
 134 The ntlm_auth manpage was written by Jelmer Vernooij\&.
 135