File: protocol.html

package info (click to toggle)
cvm 0.11-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 492 kB
  • ctags: 215
  • sloc: ansic: 1,777; makefile: 48; sh: 12
file content (84 lines) | stat: -rw-r--r-- 2,662 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<html>
<body>

<h2><a href="cvm.html">CVM</a></h2>

<h1>CVM Protocol</h1>

<h2>Input</h2>

<p>Input to the authenticator is as follows.  All items except the
first, which is a single byte, are NUL-terminated strings.  The total
length of the input must not exceed 512 bytes. <ol>

<li>Protocol number, 1.

<li>Account name base (ie user name).

<li>Account domain name.

<li>List of credentials.

<li>An empty string (ie a single NUL byte).

</ol></p>

<p>The credentials consist of one of the following:<ul>

<li>For plain login, the password.

<li>For APOP, the timestamp and MD5 digest.

<li>For CRAM-MD5 keyed hashing, as specified in RFC 2095, the
challenge and MD5 digest.

</ul></p>

<p>Each module will implement a single type of credential validation.
The invoker will choose which modules to invoke depending on what type
of credentials it needs validated.</p>

<h2>Environment Variables</h2>

<p>The following environment variables may be set by the invoker:<dl>

<dt><tt>SERVICE</tt> <dl>The service name, to be used (for example) by
PAM modules to determine which configuration file to load.

</dl></p>

<h2>Output</h2>

<p>If authentication succeeds, the output from the module is a single
byte success code followed by a list of <a href="facts.html">facts</a>
about the authenticator.  The total size of the output must not exceed
512 bytes.</p>

<p>If authentication succeeded, the code byte will be 0.  If the
credentials are accepted by this module, but are not valid, the code
will be 100 (permanent failure).  Any other code indicates a temporary
error.</p>

<p>Each fact consists of a single byte identifying what type of fact
is being reported, followed by a sequence of zero or more non-zero
bytes, terminated by a single NUL byte.  A second NUL byte follows the
last fact and indicates the end of the list.</p>

<h2>Code Considerations</h2>

<p>The module must report a temporary error if it detects malformed
input (too few credentials, etc.).  Extra input is a fault in the
invoking code, and may produce undefined results.</p>

<p>An executable module must exit 0 if authentication succeeds.
Non-zero exit codes from an executable module should be treated as a
temporary error.</p>

<p>The invoker of an executable module must assume a temporary error
if the module either fails to completely read its input or produces
incomplete output, even if the module exits without error.</p>

<p>The invoking code should change directory to the named home
directory and drop root priviledges as soon as possible after
successful authentication.  Where reasonable, the invoking code should
also chroot to the directory for added protection.</p>