1 058b0118 2005-01-03 devnull .TH ATTACH 9P 
  2 058b0118 2005-01-03 devnull .SH NAME
  3 058b0118 2005-01-03 devnull attach, auth \- messages to establish a connection
  4 058b0118 2005-01-03 devnull .SH SYNOPSIS
  5 058b0118 2005-01-03 devnull .ta \w'\fLTauth 'u
  6 058b0118 2005-01-03 devnull .IR size [4]
  7 058b0118 2005-01-03 devnull .B Tauth
  8 058b0118 2005-01-03 devnull .IR tag [2]
  9 058b0118 2005-01-03 devnull .IR afid [4]
 10 058b0118 2005-01-03 devnull .IR uname [ s ]
 11 058b0118 2005-01-03 devnull .IR aname [ s ]
 12 058b0118 2005-01-03 devnull .br
 13 058b0118 2005-01-03 devnull .IR size [4]
 14 058b0118 2005-01-03 devnull .B Rauth
 15 058b0118 2005-01-03 devnull .IR tag [2]
 16 058b0118 2005-01-03 devnull .IR aqid [13]
 17 058b0118 2005-01-03 devnull .PP
 18 058b0118 2005-01-03 devnull .IR size [4]
 19 058b0118 2005-01-03 devnull .B Tattach
 20 058b0118 2005-01-03 devnull .IR tag [2]
 21 058b0118 2005-01-03 devnull .IR fid [4]
 22 058b0118 2005-01-03 devnull .IR afid [4]
 23 058b0118 2005-01-03 devnull .IR uname [ s ]
 24 058b0118 2005-01-03 devnull .IR aname [ s ]
 25 058b0118 2005-01-03 devnull .br
 26 058b0118 2005-01-03 devnull .IR size [4]
 27 058b0118 2005-01-03 devnull .B Rattach
 28 058b0118 2005-01-03 devnull .IR tag [2]
 29 058b0118 2005-01-03 devnull .IR qid [13]
 30 058b0118 2005-01-03 devnull .SH DESCRIPTION
 31 058b0118 2005-01-03 devnull .PP
 32 058b0118 2005-01-03 devnull The
 33 058b0118 2005-01-03 devnull .B attach
 34 058b0118 2005-01-03 devnull message serves as a fresh introduction from a user on
 35 058b0118 2005-01-03 devnull the client machine to the server.
 36 058b0118 2005-01-03 devnull The message identifies the user
 37 058b0118 2005-01-03 devnull .RI ( uname )
 38 058b0118 2005-01-03 devnull and may select
 39 058b0118 2005-01-03 devnull the file tree to access
 40 058b0118 2005-01-03 devnull .RI ( aname ).
 41 058b0118 2005-01-03 devnull The
 42 058b0118 2005-01-03 devnull .I afid
 43 058b0118 2005-01-03 devnull argument specifies a fid previously established by an
 44 058b0118 2005-01-03 devnull .B auth
 45 058b0118 2005-01-03 devnull message, as described below.
 46 058b0118 2005-01-03 devnull .PP
 47 058b0118 2005-01-03 devnull As a result of the
 48 058b0118 2005-01-03 devnull .B attach
 49 058b0118 2005-01-03 devnull transaction, the client will have a connection to the root
 50 058b0118 2005-01-03 devnull directory of the desired file tree,
 51 058b0118 2005-01-03 devnull represented by
 52 058b0118 2005-01-03 devnull .IR fid .
 53 058b0118 2005-01-03 devnull An error is returned if
 54 058b0118 2005-01-03 devnull .I fid
 55 058b0118 2005-01-03 devnull is already in use.
 56 058b0118 2005-01-03 devnull The server's idea of the root of the file tree is represented by the returned
 57 058b0118 2005-01-03 devnull .IR qid .
 58 058b0118 2005-01-03 devnull .PP
 59 058b0118 2005-01-03 devnull If the client does not wish to authenticate the connection, or knows that
 60 058b0118 2005-01-03 devnull authentication is not required, the
 61 058b0118 2005-01-03 devnull .I afid
 62 058b0118 2005-01-03 devnull field in the
 63 058b0118 2005-01-03 devnull .B attach
 64 058b0118 2005-01-03 devnull message should be set to
 65 058b0118 2005-01-03 devnull .BR NOFID ,
 66 058b0118 2005-01-03 devnull defined as
 67 058b0118 2005-01-03 devnull .B (u32int)~0
 68 058b0118 2005-01-03 devnull in
 69 058b0118 2005-01-03 devnull .BR <fcall.h> .
 70 058b0118 2005-01-03 devnull If the client does wish to authenticate, it must acquire and validate an
 71 058b0118 2005-01-03 devnull .I afid
 72 058b0118 2005-01-03 devnull using an
 73 058b0118 2005-01-03 devnull .B auth
 74 058b0118 2005-01-03 devnull message before doing the
 75 058b0118 2005-01-03 devnull .BR attach .
 76 058b0118 2005-01-03 devnull .PP
 77 058b0118 2005-01-03 devnull The
 78 058b0118 2005-01-03 devnull .B auth
 79 058b0118 2005-01-03 devnull message contains
 80 058b0118 2005-01-03 devnull .IR afid ,
 81 058b0118 2005-01-03 devnull a new fid to be established for authentication, and the
 82 058b0118 2005-01-03 devnull .I uname
 83 058b0118 2005-01-03 devnull and
 84 058b0118 2005-01-03 devnull .I aname
 85 058b0118 2005-01-03 devnull that will be those of the following
 86 058b0118 2005-01-03 devnull .B attach
 87 058b0118 2005-01-03 devnull message.
 88 058b0118 2005-01-03 devnull If the server does not require authentication, it returns
 89 058b0118 2005-01-03 devnull .B Rerror
 90 058b0118 2005-01-03 devnull to the
 91 058b0118 2005-01-03 devnull .B Tauth
 92 058b0118 2005-01-03 devnull message.
 93 058b0118 2005-01-03 devnull .PP
 94 058b0118 2005-01-03 devnull If the server does require authentication, it returns
 95 058b0118 2005-01-03 devnull .I aqid
 96 058b0118 2005-01-03 devnull defining a file of type
 97 058b0118 2005-01-03 devnull .B QTAUTH
 98 058b0118 2005-01-03 devnull (see
 99 058b0118 2005-01-03 devnull .IR intro (9P))
100 058b0118 2005-01-03 devnull that may be read and written (using
101 058b0118 2005-01-03 devnull .B read
102 058b0118 2005-01-03 devnull and
103 058b0118 2005-01-03 devnull .B write
104 058b0118 2005-01-03 devnull messages in the usual way) to execute an authentication protocol.
105 058b0118 2005-01-03 devnull That protocol's definition is not part of 9P itself.
106 058b0118 2005-01-03 devnull .PP
107 058b0118 2005-01-03 devnull Once the protocol is complete, the same
108 058b0118 2005-01-03 devnull .I afid
109 058b0118 2005-01-03 devnull is presented in the
110 058b0118 2005-01-03 devnull .B attach
111 058b0118 2005-01-03 devnull message for the user, granting entry.
112 058b0118 2005-01-03 devnull The same validated
113 058b0118 2005-01-03 devnull .I afid
114 058b0118 2005-01-03 devnull may be used for multiple
115 058b0118 2005-01-03 devnull .B attach
116 058b0118 2005-01-03 devnull messages with the same
117 058b0118 2005-01-03 devnull .I uname
118 058b0118 2005-01-03 devnull and
119 058b0118 2005-01-03 devnull .IR aname .
120 058b0118 2005-01-03 devnull .SH ENTRY POINTS
121 058b0118 2005-01-03 devnull .I Fsmount
122 058b0118 2005-01-03 devnull and
123 058b0118 2005-01-03 devnull .I fsauth
124 058b0118 2005-01-03 devnull (see
125 36cd4c58 2021-01-30 crossd .MR 9pclient (3) )
126 058b0118 2005-01-03 devnull generate
127 058b0118 2005-01-03 devnull .B attach
128 058b0118 2005-01-03 devnull and
129 058b0118 2005-01-03 devnull .B auth
130 058b0118 2005-01-03 devnull transactions.
131 058b0118 2005-01-03 devnull .\" An
132 058b0118 2005-01-03 devnull .\" .B attach
133 058b0118 2005-01-03 devnull .\" transaction will be generated for kernel devices
134 058b0118 2005-01-03 devnull .\" (see
135 058b0118 2005-01-03 devnull .\" .IR intro (3))
136 058b0118 2005-01-03 devnull .\" when a system call evaluates a file name
137 058b0118 2005-01-03 devnull .\" beginning with
138 058b0118 2005-01-03 devnull .\" .LR # .
139 058b0118 2005-01-03 devnull .\" .IR Pipe (2)
140 058b0118 2005-01-03 devnull .\" generates an attach on the kernel device
141 058b0118 2005-01-03 devnull .\" .IR pipe (3).
142 058b0118 2005-01-03 devnull .\" The
143 058b0118 2005-01-03 devnull .\" .I mount
144 058b0118 2005-01-03 devnull .\" system call
145 058b0118 2005-01-03 devnull .\" (see
146 058b0118 2005-01-03 devnull .\" .IR bind (2))
147 058b0118 2005-01-03 devnull .\" generates an
148 058b0118 2005-01-03 devnull .\" .B attach
149 058b0118 2005-01-03 devnull .\" message to the remote file server.
150 058b0118 2005-01-03 devnull .\" When the kernel boots, an
151 058b0118 2005-01-03 devnull .\" .I attach
152 058b0118 2005-01-03 devnull .\" is made to the root device,
153 058b0118 2005-01-03 devnull .\" .IR root (3),
154 058b0118 2005-01-03 devnull .\" and then an
155 058b0118 2005-01-03 devnull .\" .B attach
156 058b0118 2005-01-03 devnull .\" is made to the requested file server machine.
157 058b0118 2005-01-03 devnull .\" .PP
158 058b0118 2005-01-03 devnull .\" An
159 058b0118 2005-01-03 devnull .\" .B auth
160 058b0118 2005-01-03 devnull .\" transaction is generated by the
161 058b0118 2005-01-03 devnull .\" .IR fauth (2)
162 058b0118 2005-01-03 devnull .\" system call or by the first
163 058b0118 2005-01-03 devnull .\" .B mount
164 058b0118 2005-01-03 devnull .\" system call on an uninitialized connection.
165 058b0118 2005-01-03 devnull .SH SEE ALSO
166 36cd4c58 2021-01-30 crossd .MR 9pclient (3) ,
167 058b0118 2005-01-03 devnull .IR version (9P),
168 058b0118 2005-01-03 devnull Plan 9's \fIauthsrv\fR(6)