summaryrefslogtreecommitdiffstats
path: root/lib/libutil
diff options
context:
space:
mode:
authorjhb <jhb@FreeBSD.org>2008-01-14 23:49:56 +0000
committerjhb <jhb@FreeBSD.org>2008-01-14 23:49:56 +0000
commitdb1781cf23171042e8c97bf1e3707d9094c0c2a4 (patch)
tree59d9a9505a08bf18102c79abd0dc8ae658620eb4 /lib/libutil
parent533f13b8b27556700f86522a104894994e90f98b (diff)
downloadFreeBSD-src-db1781cf23171042e8c97bf1e3707d9094c0c2a4.zip
FreeBSD-src-db1781cf23171042e8c97bf1e3707d9094c0c2a4.tar.gz
Update the manpage for openpty(3) to account for the recent fixes.
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
Diffstat (limited to 'lib/libutil')
-rw-r--r--lib/libutil/pty.332
1 files changed, 14 insertions, 18 deletions
diff --git a/lib/libutil/pty.3 b/lib/libutil/pty.3
index 35f0b82..08a5985 100644
--- a/lib/libutil/pty.3
+++ b/lib/libutil/pty.3
@@ -48,13 +48,13 @@ The function
.Fn openpty
attempts to obtain the next available pseudo-terminal from the system (see
.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,
the group membership to the group
.Dq tty
(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
-invalidate any current use of the line by calling
+reading and writing by the owner, and for writing by the group, and
+invalidates any current use of the line by calling
.Xr revoke 2 .
.Pp
If the argument
@@ -114,12 +114,19 @@ The
function returns -1 on failure, 0 in the slave process, and the process ID of
the slave process in the parent process.
.Sh ERRORS
-On failure,
+The
.Fn openpty
-will set the global variable
+function may fail and set the global variable
.Dv errno
-to
-.Er ENOENT .
+for any of the errors specified for the
+.Xr grantpt 3 ,
+.Xr posix_openpt 3 ,
+.Xr ptsname 3 ,
+and
+.Xr unlockpt 3
+functions and the
+.Xr revoke 2
+system call.
.Pp
In addition to this,
.Fn forkpty
@@ -136,14 +143,3 @@ may set it to any value as described for
.Xr pty 4 ,
.Xr termios 4 ,
.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 ) .
OpenPOWER on IntegriCloud