summaryrefslogtreecommitdiff
path: root/usr/src/man/man3sasl
diff options
context:
space:
mode:
authorJerry Jelinek <jerry.jelinek@joyent.com>2016-06-22 12:55:10 +0000
committerJerry Jelinek <jerry.jelinek@joyent.com>2016-06-22 12:55:10 +0000
commit8bae72dc3f645da905eab5fe960867037f57bae0 (patch)
tree24dce03bc58aa36ef080558a440d351c2237d4db /usr/src/man/man3sasl
parent766f41d1d95d047e65ac4942d66037ce7f924027 (diff)
parent01aaaf328842760a1002109b299908a027e94cf8 (diff)
downloadillumos-joyent-release-20160625.tar.gz
[illumos-gate merge]release-20160625
commit 01aaaf328842760a1002109b299908a027e94cf8 7051 want id_space(9F) docs commit c1de7575521deda5ee777b8054a9c5b12f15b1ee 7120 mDNS resync was not wsdiff safe commit 9c05409f2b9301e686735887a9573454cceb0331 7069 i386_XARCH should include -m32 commit 406fc5100dac8d225a315a6def6be8d628f34e24 6602 lofi should support labeled devices commit f3a07f941f1be263a48a040c059edbcb722cf436 4712 Prefer 'parsable' over 'parseable' in the manual pages commit 1b2031a95889aea96be6af55dcf31a0d5ffdfed9 7050 Prefer 'subcommand' over 'sub-command' in the manual pages commit 831b40b1c811223fd0b1131791a38e3ae5143377 7049 Prefer 'writable' over 'writeable' in the manual pages commit a716f1a92056bc2e231e57ae2a20725ce606ea73 7047 Fix spelling mistakes in sections 9E, 9F and 9S commit 95e15299a2c42b8014fa27631a6f3be2a93febc2 7048 Fix spelling mistakes in sections 7D, 7I, 7IPP, and 7P commit df23565fe1d0b225f9f898c50dfafea6749b0b7f 7046 Fix spelling mistakes in section 5 commit c855112f85cf71e42f6381a66f3f86f98e2ed24e 7045 Fix spelling mistakes in section 4 commit 843c398e8904ed9d833d2af3103894f909fb4b52 7042 Fix spelling mistakes in library sections commit 0db8de19c0e494758b68b702523a2b0eaffe3b2e 7044 Fix spelling mistakes in sections 1HAS and 2 commit df23d905b96680e56379c5a5ecb4b363f36b9e74 7041 Fix spelling mistakes in sections 1 and 1M commit 71af3be340c57171837478555e2eb0d496318cfc 7040 Detect common spelling errors in manual pages Conflicts: usr/src/uts/common/fs/vfs.c usr/src/man/man7d/cpuid.7d usr/src/man/man5/privileges.5 usr/src/man/man3c/signalfd.3c usr/src/cmd/lofiadm/main.c
Diffstat (limited to 'usr/src/man/man3sasl')
-rw-r--r--usr/src/man/man3sasl/sasl_auxprop.3sasl34
1 files changed, 9 insertions, 25 deletions
diff --git a/usr/src/man/man3sasl/sasl_auxprop.3sasl b/usr/src/man/man3sasl/sasl_auxprop.3sasl
index f3af6b1c46..b0b13b3cf3 100644
--- a/usr/src/man/man3sasl/sasl_auxprop.3sasl
+++ b/usr/src/man/man3sasl/sasl_auxprop.3sasl
@@ -5,11 +5,11 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH SASL_AUXPROP 3SASL "Oct 14, 2003"
+.TH SASL_AUXPROP 3SASL "April 9, 2016"
.SH NAME
sasl_auxprop, prop_new, prop_dup, prop_request, prop_get, prop_getnames,
prop_clear, prop_erase, prop_dispose, prop_format, prop_set, prop_setvals \-
-SASL auxilliary properties
+SASL auxiliary properties
.SH SYNOPSIS
.LP
.nf
@@ -74,43 +74,37 @@ SASL auxilliary properties
.fi
.SH DESCRIPTION
-.sp
.LP
-The SASL auxilliary properties are used to obtain properties from external
-sources during the authentication process. For example, a mechanizm might need
+The SASL auxiliary properties are used to obtain properties from external
+sources during the authentication process. For example, a mechanism might need
to query an LDAP server to obtain the authentication secret. The application
probably needs other information from the LDAP server as well, such as the home
-directory of the UID. The auxilliary property interface allows the two to
+directory of the UID. The auxiliary property interface allows the two to
cooperate and results in only a single query against the property sources.
.sp
.LP
Property lookups take place directly after user canonicalization occurs.
Therefore, all request should be registered with the context before user
-canonicalization occurs. Requests can calso be registered by using the
-\fBsasl_auxprop_request\fR(3SASL) function. Most of the auxilliary property
+canonicalization occurs. Requests can also be registered by using the
+\fBsasl_auxprop_request\fR(3SASL) function. Most of the auxiliary property
functions require a property context that can be obtained by calling
\fBsasl_auxprop_getctx\fR(3SASL).
.SS "\fBprop_new()\fR"
-.sp
.LP
The \fBprop_new()\fR function creates a new property context. It is unlikely
that application developers will use this call.
.SS "\fBprop_dup()\fR"
-.sp
.LP
The \fBprop_dup()\fR function duplicates a given property context.
.SS "\fBprop_request()\fR"
-.sp
.LP
The \fBprop_request()\fR function adds properties to the request list of a
given context.
.SS "\fBprop_get()\fR"
-.sp
.LP
The \fBprop_get()\fR function returns a null-terminated array of \fBstruct\fR
\fBpropval\fR from the given context.
.SS "\fBprop_getnames()\fR"
-.sp
.LP
The \fBprop_getnames()\fR function fills in an array of \fBstruct\fR
\fBpropval\fR based on a list of property names. The \fBvals\fR array is at
@@ -123,39 +117,32 @@ requested, then its associated values entry will be set to \fINULL\fR.
The \fBprop_getnames()\fR function returns the number of matching properties
that were found or a SASL error code.
.SS "\fBprop_clear()\fR"
-.sp
.LP
The \fBprop_clear()\fR function clears \fIvalues\fR and \fIrequests\fR from a
property context. If the value of \fIrequests\fR is \fB1\fR, then
\fIrequests\fR is cleared. Otherwise, the value of \fIrequests\fR is \fB0\fR.
.SS "\fBprop_erase()\fR"
-.sp
.LP
The \fBprop_erase()\fR function securely erases the value of a property.
\fIname\fR is the name of the property to erase.
.SS "\fBprop_dispose()\fR"
-.sp
.LP
The \fBprop_dispose()\fR function disposes of a property context and nullifies
the pointer.
.SS "\fBprop_format()\fR"
-.sp
.LP
The \fBprop_format()\fR function formats the requested property names into a
string. The \fBprop_format()\fR function is not intended to be used by the
application. The function is used only by \fBauxprop\fR plug-ins.
.SS "\fBprop_set()\fR"
-.sp
.LP
The \fBprop_set()\fR functions adds a property value to the context. The
\fBprop_set()\fR function is used only by \fBauxprop\fR plug-ins.
.SS "\fBprop_setvals()\fR"
-.sp
.LP
The \fBprop_setvals()\fR function adds multiple values to a single property.
The \fBprop_setvals()\fR function is used only by \fBauxprop\fR plug-ins.
.SH PARAMETERS
-.sp
.ne 2
.na
\fB\fIconn\fR\fR
@@ -260,8 +247,8 @@ The separator to use for the string.
\fB\fIseplen\fR\fR
.ad
.RS 12n
-The length of the separator. The the values is less than 0, then \fBstrlen\fR
-will be used as \fIsep\fR.
+The length of the separator. If the value is less than 0, then \fBstrlen\fR
+will be used to determine the length of \fIsep\fR instead.
.RE
.sp
@@ -301,14 +288,12 @@ A null-terminated array of values to be added to the property.
.RE
.SH ERRORS
-.sp
.LP
The \fBsasl_auxprop()\fR functions that return an \fBint\fR will return a SASL
error code. See \fBsasl_errors\fR(3SASL). Those \fBsasl_auxprop()\fR functions
that return a pointer will return a valid pointer upon success and return
\fINULL\fR upon failure.
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -326,7 +311,6 @@ MT-Level MT-Safe
.TE
.SH SEE ALSO
-.sp
.LP
\fBsasl_auxprop_getctx\fR(3SASL), \fBsasl_auxprop_request\fR(3SASL),
\fBsasl_errors\fR(3SASL), \fBattributes\fR(5)