File: auth.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (88 lines) | stat: -rw-r--r-- 1,524 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
85
86
87
88
.TH auth 3 "kernel  2.12.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
auth \- Erlang Network Authentication Server
.SH DESCRIPTION
.LP
This module is deprecated\&. For a description of the Magic Cookie system, refer to Distributed Erlang in the Erlang Reference Manual\&.

.SH EXPORTS
.LP
.B
is_auth(Node) -> yes | no
.br
.RS
.TP
Types
Node = node()
.br
.RE
.RS
.LP
Returns \fIyes\fR if communication with \fINode\fR is authorized\&. Note that a connection to \fINode\fR will be established in this case\&. Returns \fIno\fR if \fINode\fR does not exist or communication is not authorized (it has another cookie than \fIauth\fR thinks it has)\&.
.LP
Use net_adm:ping(Node) instead\&.
.RE
.LP
.B
cookie() -> Cookie
.br
.RS
.TP
Types
Cookie = atom()
.br
.RE
.RS
.LP
Use erlang:get_cookie() instead\&.
.RE
.LP
.B
cookie(TheCookie) -> true
.br
.RS
.TP
Types
TheCookie = Cookie | [Cookie]
.br
  The cookie may also be given as a list with a single atom element
.br
Cookie = atom()
.br
.RE
.RS
.LP
Use erlang:set_cookie(node(), Cookie) instead\&.
.RE
.LP
.B
node_cookie([Node, Cookie]) -> yes | no
.br
.RS
.TP
Types
Node = node()
.br
Cookie = atom()
.br
.RE
.RS
.LP
Equivalent to node_cookie(Node, Cookie)\&.
.RE
.LP
.B
node_cookie(Node, Cookie) -> yes | no
.br
.RS
.TP
Types
Node = node()
.br
Cookie = atom()
.br
.RE
.RS
.LP
Sets the magic cookie of \fINode\fR to \fICookie\fR, and verifies the status of the authorization\&. Equivalent to calling erlang:set_cookie(Node, Cookie), followed by auth:is_auth(Node)\&.
.RE