d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the manpage for openpty(3) to account for the recent fixes.

Browse Source 
Specifically, remove the BUGS section and note that openpty(3) now always
does the various security-related steps.  Also, update the error return
value section.  The PR below is for the original bug rather than the doc
updates.

MFC after:	1 week
PR:		bin/9770
This commit is contained in:
John Baldwin 2008-01-14 23:49:56 +00:00
parent 160e76972a
commit 16fd04e88e
1 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
lib/libutil/pty.3
View File

@ -48,13 +48,13 @@ The function
.Fn openpty .Fn openpty
attempts to obtain the next available pseudo-terminal from the system (see attempts to obtain the next available pseudo-terminal from the system (see
.Xr pty 4 ) . .Xr pty 4 ) .
If it successfully finds one, it subsequently tries to change the If it successfully finds one, it subsequently changes the
ownership of the slave device to the real UID of the current process, ownership of the slave device to the real UID of the current process,
the group membership to the group the group membership to the group
.Dq tty .Dq tty
(if such a group exists in the system), the access permissions for (if such a group exists in the system), the access permissions for
reading and writing by the owner, and for writing by the group, and to reading and writing by the owner, and for writing by the group, and
invalidate any current use of the line by calling invalidates any current use of the line by calling
.Xr revoke 2 . .Xr revoke 2 .
.Pp .Pp
If the argument If the argument
@ -114,12 +114,19 @@ The
function returns -1 on failure, 0 in the slave process, and the process ID of function returns -1 on failure, 0 in the slave process, and the process ID of
the slave process in the parent process. the slave process in the parent process.
.Sh ERRORS .Sh ERRORS
On failure, The
.Fn openpty .Fn openpty
will set the global variable function may fail and set the global variable
.Dv errno .Dv errno
to for any of the errors specified for the
.Er ENOENT . .Xr grantpt 3 ,
.Xr posix_openpt 3 ,
.Xr ptsname 3 ,
and
.Xr unlockpt 3
functions and the
.Xr revoke 2
system call.
.Pp .Pp
In addition to this, In addition to this,
.Fn forkpty .Fn forkpty
@ -136,14 +143,3 @@ may set it to any value as described for
.Xr pty 4 , .Xr pty 4 ,
.Xr termios 4 , .Xr termios 4 ,
.Xr group 5 .Xr group 5
.Sh BUGS
The calling process must have an effective UID of super-user in order
to perform all the intended actions.
No notification will occur if
.Fn openpty
or
.Fn forkpty
failed to proceed with one of the described steps, as long as they could
at least allocate the pty at all (and create the new process in the case
of
.Fn forkpty ) .