| 1 | .\" -*- nroff -*- |
|---|
| 2 | .\" |
|---|
| 3 | .\" Copyright (c) 2001 Carnegie Mellon University. All rights reserved. |
|---|
| 4 | .\" |
|---|
| 5 | .\" Redistribution and use in source and binary forms, with or without |
|---|
| 6 | .\" modification, are permitted provided that the following conditions |
|---|
| 7 | .\" are met: |
|---|
| 8 | .\" |
|---|
| 9 | .\" 1. Redistributions of source code must retain the above copyright |
|---|
| 10 | .\" notice, this list of conditions and the following disclaimer. |
|---|
| 11 | .\" |
|---|
| 12 | .\" 2. Redistributions in binary form must reproduce the above copyright |
|---|
| 13 | .\" notice, this list of conditions and the following disclaimer in |
|---|
| 14 | .\" the documentation and/or other materials provided with the |
|---|
| 15 | .\" distribution. |
|---|
| 16 | .\" |
|---|
| 17 | .\" 3. The name "Carnegie Mellon University" must not be used to |
|---|
| 18 | .\" endorse or promote products derived from this software without |
|---|
| 19 | .\" prior written permission. For permission or any other legal |
|---|
| 20 | .\" details, please contact |
|---|
| 21 | .\" Office of Technology Transfer |
|---|
| 22 | .\" Carnegie Mellon University |
|---|
| 23 | .\" 5000 Forbes Avenue |
|---|
| 24 | .\" Pittsburgh, PA 15213-3890 |
|---|
| 25 | .\" (412) 268-4387, fax: (412) 268-7395 |
|---|
| 26 | .\" tech-transfer@andrew.cmu.edu |
|---|
| 27 | .\" |
|---|
| 28 | .\" 4. Redistributions of any form whatsoever must retain the following |
|---|
| 29 | .\" acknowledgment: |
|---|
| 30 | .\" "This product includes software developed by Computing Services |
|---|
| 31 | .\" at Carnegie Mellon University (http://www.cmu.edu/computing/)." |
|---|
| 32 | .\" |
|---|
| 33 | .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO |
|---|
| 34 | .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY |
|---|
| 35 | .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE |
|---|
| 36 | .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|---|
| 37 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN |
|---|
| 38 | .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING |
|---|
| 39 | .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|---|
| 40 | .\" |
|---|
| 41 | .TH sasl_getprop "10 July 2001" SASL "SASL man pages" |
|---|
| 42 | .SH NAME |
|---|
| 43 | sasl_getprop \- Get a SASL property |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | .SH SYNOPSIS |
|---|
| 47 | .nf |
|---|
| 48 | .B #include <sasl/sasl.h> |
|---|
| 49 | |
|---|
| 50 | .sp |
|---|
| 51 | .BI "int sasl_getprop(sasl_conn_t " *conn ", " |
|---|
| 52 | .BI " int " propnum ", " |
|---|
| 53 | .BI " const void ** " pvalue ");" |
|---|
| 54 | |
|---|
| 55 | .fi |
|---|
| 56 | .SH DESCRIPTION |
|---|
| 57 | |
|---|
| 58 | .B sasl_getprop |
|---|
| 59 | gets the value of a SASL property. For example after successful |
|---|
| 60 | authentication a server may wish to know the authorization name. Or a |
|---|
| 61 | client application may wish to know the strength of the negotiated |
|---|
| 62 | security layer. |
|---|
| 63 | |
|---|
| 64 | .I conn |
|---|
| 65 | is the SASL connection object. |
|---|
| 66 | .I propnum |
|---|
| 67 | is the identifier for the property requested and |
|---|
| 68 | .I pvalue |
|---|
| 69 | is filled in on success. List of properties follows: |
|---|
| 70 | |
|---|
| 71 | .nf |
|---|
| 72 | SASL_USERNAME - pointer to NUL terminated user name |
|---|
| 73 | SASL_SSF - security layer security strength factor, |
|---|
| 74 | if 0, call to sasl_encode, sasl_decode unnecessary |
|---|
| 75 | SASL_MAXOUTBUF - security layer max output buf unsigned |
|---|
| 76 | SASL_DEFUSERREALM - server authentication realm used |
|---|
| 77 | SASL_GETOPTCTX - context for getopt callback |
|---|
| 78 | SASL_IPLOCALPORT - local address string |
|---|
| 79 | SASL_IPREMOTEPORT - remote address string |
|---|
| 80 | SASL_SERVICE - service passed to sasl_*_new |
|---|
| 81 | SASL_SERVERFQDN - serverFQDN passed to sasl_*_new |
|---|
| 82 | SASL_AUTHSOURCE - name of auth source last used, useful for failed |
|---|
| 83 | authentication tracking |
|---|
| 84 | SASL_MECHNAME - active mechanism name, if any |
|---|
| 85 | SASL_PLUGERR - similar to sasl_errdetail |
|---|
| 86 | .fi |
|---|
| 87 | |
|---|
| 88 | .PP |
|---|
| 89 | |
|---|
| 90 | .SH "RETURN VALUE" |
|---|
| 91 | Returns SASL_OK on success. SASL error code on failure. |
|---|
| 92 | |
|---|
| 93 | .SH "CONFORMING TO" |
|---|
| 94 | RFC 2222 |
|---|
| 95 | .SH "SEE ALSO" |
|---|
| 96 | sasl(3), sasl_errors(3), sasl_server_new(3), sasl_client_new(3) |
|---|
