components/cyrus-sasl/Solaris/usr/share/man/man3/sasl_erasebuffer.3
author Jan Parcel <jan.parcel@oracle.com>
Tue, 03 Nov 2015 14:27:41 -0800
changeset 5055 9daf220c1a9a
child 5769 6303cfed086b
permissions -rw-r--r--
PSARC/2015/194 libsasl ON to Userland migration and update 20855050 Update libsasl 2.1.15 to 2.1.26 and migrate to Userland consolidation 15242150 SUNBT6211461 SASL library missing extras 20544079 sasl install dir for plugins should be separately configurable 20544093 ifdef sun for gethostname in saslutil.c is obsolete 20544122 libtool.m4 overrides configuration for --no-verify 20544160 incorrect function definition for do_request in ipc_doors.c 20544105 sasl adjustment for location of gssapi.h incorrectly implemented 21058782 CMU cyrus-sasl missing man pages that we require 21099377 Moving to autotools 1.15 breaks cmu cyrus-sasl build 21131962 libsasl mv to Userland means subversion requires system/library/security/libsasl 22052798 openldap slapd refuses to run if libsasl updated unless openldap recompiled
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5055
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     1
'\" te
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     2
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     3
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     4
.TH sasl_erasebuffer 3SASL "16 Sep 2003" "SunOS 5.12" "Simple Authentication Security Layer Library Functions"
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     5
.SH NAME
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     6
sasl_erasebuffer \- erase buffer
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     7
.SH SYNOPSIS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     8
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
     9
.nf
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    10
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    11
#include <sasl/saslutil.h>
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    12
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    13
\fBvoid\fR \fBsasl_erasebuffer\fR(\fBchar *\fR\fIpass\fR, \fBunsigned\fR \fIlen\fR);
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    14
.fi
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    15
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    16
.SH DESCRIPTION
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    17
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    18
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    19
Use the \fBsasl_erasebuffer()\fR interface to erase a security sensitive buffer or password. The implementation may use recovery-resistant erase logic.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    20
.SH PARAMETERS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    21
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    22
.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    23
.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    24
.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    25
\fB\fIpass\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    26
.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    27
.RS 8n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    28
.rt  
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    29
A password
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    30
.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    31
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    32
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    33
.ne 2
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    34
.mk
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    35
.na
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    36
\fB\fIlen\fR\fR
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    37
.ad
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    38
.RS 8n
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    39
.rt  
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    40
The length of the password
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    41
.RE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    42
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    43
.SH RETURN VALUES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    44
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    45
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    46
The \fBsasl_erasebuffer()\fR interface returns no return values.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    47
.SH ERRORS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    48
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    49
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    50
None.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    51
.SH ATTRIBUTES
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    52
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    53
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    54
See \fBattributes\fR(5) for descriptions of the following attributes:
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    55
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    56
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    57
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    58
.TS
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    59
tab() box;
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    60
cw(2.75i) |cw(2.75i) 
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    61
lw(2.75i) |lw(2.75i) 
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    62
.
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    63
ATTRIBUTE TYPEATTRIBUTE VALUE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    64
_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    65
Availabilitysystem/library/security/libsasl
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    66
_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    67
Interface StabilityCommitted
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    68
_
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    69
MT-LevelMT-Safe
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    70
.TE
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    71
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    72
.SH SEE ALSO
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    73
.sp
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    74
.LP
9daf220c1a9a PSARC/2015/194 libsasl ON to Userland migration and update
Jan Parcel <jan.parcel@oracle.com>
parents:
diff changeset
    75
\fBattributes\fR(5)