History

270228c improve descriptions in security-ssl(2) and ssl(3)

Charles.Forsyth committed 19 years ago

Commit e83f2ff1 parent 919cd7f2 files · +24 −27Browse files

Unified · Split

2 files
  1. man/2/security-ssl +3 −14
  2. man/3/ssl +21 −13
man/2/security-ssl+3−14
@@ -46,20 +46,9 @@ which is read and written to exchange data on the original · 45 unmodified lines
46using SSL.46using SSL.
47.PP47.PP
48.B Secret48.B Secret
49writes49sets the secrets for each direction on Connection
50.I secretin50.I c ;
51and51if a secret is nil, the existing setting for that direction remains unchanged.
52.I secretout
53to
54.IB c .dir/secretin
55and
56.IB c .dir/secretout
57where
58.I n
59is obtained from the
60.B Connection
61adt
62.IR c .
63The string returned describes errors encountered, if any; otherwise it is nil.52The string returned describes errors encountered, if any; otherwise it is nil.
64.PP53.PP
65.SH SOURCE54.SH SOURCE
man/3/ssl+21−13
@@ -2,24 +2,27 @@ · 1 unmodified line
2.SH NAME2.SH NAME
3ssl \- secure sockets layer device3ssl \- secure sockets layer device
4.SH SYNOPSIS4.SH SYNOPSIS
5.B bind '#D' /n/ssl5.B #D/clone
6.PP6.br
7.B /n/ssl/clone7.BI #D/ n
8.br
9.BI #D/ n /data
8.br10.br
9.BI /n/ssl/ n11.BI #D/ n /ctl
10.br12.br
11.BI /n/ssl/ n /data13.BI #D/ n /secretin
12.br14.br
13.BI /n/ssl/ n /ctl15.BI #D/ n /secretout
14.br16.br
15.BI /n/ssl/ n /secretin17.BI #D/ n /encalgs
16.br18.br
17.BI /n/ssl/ n /secretout19.BI #D/ n /hashalgs
18.SH DESCRIPTION20.SH DESCRIPTION
19The21The
20.I ssl22.I ssl
21device provides access to a Secure Socket Layer that implements the record layer protocol23device provides access to a Secure Socket Layer that implements the record layer protocol
22of SSLv2.24of SSLv2
25(but not its handshaking).
23The device provides encrypting and digesting for many independent connections.26The device provides encrypting and digesting for many independent connections.
24Once associated with a network connection, the27Once associated with a network connection, the
25.I ssl28.I ssl
@@ -29,6 +32,10 @@ can send data in the clear, digested or encrypted. In all cases, if · 3 unmodified lines
29.I ssl32.I ssl
30is associated with both ends of a connection, all messages are delimited.33is associated with both ends of a connection, all messages are delimited.
31As long as reads always specify buffers that are of equal or greater lengths than the writes at the other end of the connection, one write will correspond to one read.34As long as reads always specify buffers that are of equal or greater lengths than the writes at the other end of the connection, one write will correspond to one read.
35The device is unusual because it is not bound into the name space but named directly by its local name,
36.BR #D .
37That is because the interface described below requires writing a local file descriptor number to a file,
38which will not work remotely.
32.PP39.PP
33The top-level directory contains a40The top-level directory contains a
34.B clone41.B clone
@@ -41,16 +48,17 @@ will be open on the control file, · 6 unmodified lines
41.BR ctl ,48.BR ctl ,
42in the directory that represents the new connection.49in the directory that represents the new connection.
43Reading the control file will return a text string giving the connection number50Reading the control file will return a text string giving the connection number
44(and thus the directory name).51.IR n ,
52and thus the directory name.
45.PP53.PP
46Writing to54Writing to
47.B ctl55.B ctl
48controls the corresponding connection.56controls the corresponding connection.
49The following control messages are possible:57The following control messages are possible:
50.TP58.TP
51.BI fd " n"59.BI fd " m"
52Associate the network connection on file descriptor60Associate the network connection on existing file descriptor
53.I n61.I m
54with the62with the
55.I ssl63.I ssl
56device.64device.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t