Index: stable/8/lib/librpcsec_gss/rpc_gss_get_error.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_get_error.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_get_error.3 (revision 203394) @@ -1,58 +1,58 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_GET_ERROR 3 .Os .Sh NAME .Nm rpc_gss_get_error .Nd "Get error details" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft void .Fn rpc_gss_get_error "rpc_gss_error_t *error" .Sh DESCRIPTION Get details of the last RPCSEC_GSS error. .Sh PARAMETERS .Bl -tag .It error A pointer to a structure where the error details will be returned .El .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_get_mech_info.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_get_mech_info.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_get_mech_info.3 (revision 203394) @@ -1,68 +1,68 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_GET_MECH_INFO 3 .Os .Sh NAME .Nm rpc_gss_get_mech_info .Nd "Get extra information about a security mechanism" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft const char ** .Fn rpc_gss_get_mech_info "const char *mech" "rpc_gss_service_t *service" .Sh DESCRIPTION This function looks up a mechanism by name by reading the file /etc/gss/mech and queries it for its capabilities. .Sh PARAMETERS .Bl -tag .It mech The mechanism to search for .It service If the mechanism is found, the maximum supported service type is returned in .Fa *service .El .Sh RETURN VALUES If the mechanism is found, a list of the supported qualities of protection is returned, otherwise .Dv NULL . .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_get_mechanisms.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_get_mechanisms.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_get_mechanisms.3 (revision 203394) @@ -1,55 +1,55 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_GET_MECHANISMS 3 .Os .Sh NAME .Nm rpc_gss_get_mechanisms .Nd "Get installed mechanisms" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft const char ** .Fn rpc_gss_get_mechanisms "void" .Sh DESCRIPTION Return a .Dv NULL terminated list of installed security mechanisms. .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_get_principal_name.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_get_principal_name.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_get_principal_name.3 (revision 203394) @@ -1,82 +1,82 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_GET_PRINCIPAL_NAME 3 .Os .Sh NAME .Nm rpc_gss_get_principal_name .Nd "Get a principal name" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fo rpc_gss_get_principal_name .Fa "rpc_gss_principal_t *principal" .Fa "const char *mech" .Fa "const char *name" .Fa "const char *node" .Fa "const char *domain" .Fc .Sh DESCRIPTION This function can be used to generate a client principal name from various strings. .Sh PARAMETERS .Bl -tag .It principal If the principal is created successfully, .Fa *principal will be set to point at the new principal in GSS-API exported name form .It mech The name of the mechanism for this principal .It name The name part of the principal .It node If non-null, the hostname or instance part of the principal .It domain If non-null, the domain or realm part of the principal .El .Sh RETURN VALUES Returns .Dv TRUE if the principal was created or .Dv FALSE otherwise .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr gss_export_name 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_get_versions.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_get_versions.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_get_versions.3 (revision 203394) @@ -1,64 +1,64 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_GET_VERSIONS 3 .Os .Sh NAME .Nm rpc_gss_get_versions .Nd "Get supported protocol version" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fn rpc_gss_get_versions "u_int *vers_hi" "u_int *vers_lo" .Sh DESCRIPTION Return the highest and lowest supported versions of the RPCSEC_GSS protocol. .Sh PARAMETERS .Bl -tag .It vers_hi The value of .Fa *vers_hi is set to the highest suppored protocol version .It vers_lo The value of .Fa *vers_lo is set to the lowest suppored protocol version .El .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_getcred.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_getcred.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_getcred.3 (revision 203394) @@ -1,85 +1,85 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_GETCRED 3 .Os .Sh NAME .Nm rpc_gss_getcred .Nd "Get authorization information for an RPC request" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft AUTH * .Fo rpc_gss_getcred .Fa "struct svc_req *req" .Fa "rpc_gss_rawcred_t **rcred" .Fa "rpc_gss_ucred_t **ucred" .Fa "void **cookie" .Fc .Sh DESCRIPTION This function returns the RPCSEC_GSS authenticated credentials associated with an RPC request. .Sh PARAMETERS .Bl -tag .It req The RPC request to query .It rcred If non-null, .Fa *rcred is set to point at the raw credentials for this request .It ucred .It rcred If non-null, .Fa *ucred is set to point at the corresponding unix credentials .It cookie If non-null, .Fa *cookie is set to the cookie value returned by a callback function registered with .Fn rpc_gss_set_callback .El .Sh RETURN VALUES Returns .Dv TRUE if successful, .Dv FALSE otherwise. .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpc_gss_set_callback 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_is_installed.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_is_installed.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_is_installed.3 (revision 203394) @@ -1,65 +1,65 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_IS_INSTALLED 3 .Os .Sh NAME .Nm rpc_gss_is_installed .Nd "Query for the presence os a security mechanism" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fn rpc_gss_is_installed "const char *mech" .Sh DESCRIPTION This function looks up a mechanism by name by reading the file /etc/gss/mech. .Sh PARAMETERS .Bl -tag .It mech The mechanism to search for .El .Sh RETURN VALUES Returns .Dv TRUE if the mechanism is installed, .Dv FALSE otherwise. .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_max_data_length.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_max_data_length.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_max_data_length.3 (revision 203394) @@ -1,64 +1,64 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_MAX_DATA_LENGTH 3 .Os .Sh NAME .Nm rpc_gss_max_data_length .Nd "calculate maximum data size" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft int .Fn rpc_gss_max_data_length "AUTH *auth" "int max_tp_unit_len" .Sh DESCRIPTION Calculate the maximum message size that will fit into a packet of size .Fa max_tp_unit_len , given the current service and QoP setting. .Sh PARAMETERS .Bl -tag .It auth A handle to a RPCSEC_GSS security ccontext .It max_tp_unit_len Maximum packet size of the underlying transport protocol .El .Sh RETURN VALUES The maximum message size that can be encoded .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_mech_to_oid.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_mech_to_oid.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_mech_to_oid.3 (revision 203394) @@ -1,68 +1,68 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_MECH_TO_OID 3 .Os .Sh NAME .Nm rpc_gss_mech_to_oid .Nd "Convert a mechanism name to a GSS-API oid" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fn rpc_gss_mech_to_oid "const char *mech" "gss_OID *oid_ret" .Sh DESCRIPTION This function looks up a mechanism by name by reading the file /etc/gss/mech. .Sh PARAMETERS .Bl -tag .It mech The mechanism name to search for .It oid_ret If the mechanism is found, the corresponding GSS-API oid is returned in .Fa *oid_ret .El .Sh RETURN VALUES If the mechanism is found, .Dv TRUE is returned, otherwise .Dv FALSE . .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_oid_to_mech.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_oid_to_mech.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_oid_to_mech.3 (revision 203394) @@ -1,68 +1,68 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_OID_TO_MECH 3 .Os .Sh NAME .Nm rpc_gss_oid_to_mech .Nd "Convert a mechanism name to a GSS-API oid" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fn rpc_gss_oid_to_mech "gss_OID oid" "const char **mech_ret" .Sh DESCRIPTION This function looks up a mechanism by oid by reading the file /etc/gss/mech. .Sh PARAMETERS .Bl -tag .It oid The mechanism oid to search for .It mech_ret If the mechanism is found, the corresponding mechanism name is returned in .Fa *mech_ret .El .Sh RETURN VALUES If the mechanism is found, .Dv TRUE is returned, otherwise .Dv FALSE . .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_qop_to_num.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_qop_to_num.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_qop_to_num.3 (revision 203394) @@ -1,70 +1,70 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_QOP_TO_NUM 3 .Os .Sh NAME .Nm rpc_gss_qop_to_num .Nd "Convert a quality of protection name to number" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fn rpc_gss_qop_to_num "const char *qop" "const char *mech" "u_int *num_ret" .Sh DESCRIPTION This function looks up a quality of protection by name by reading the file /etc/gss/qop. .Sh PARAMETERS .Bl -tag .It qop The quality of protection to search for .It mech The mechanism name to search for .It number_ret If the quality of protection is found, the corresponding number is returned in .Fa *num_ret .El .Sh RETURN VALUES If the value is found, .Dv TRUE is returned, otherwise .Dv FALSE . .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_seccreate.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_seccreate.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_seccreate.3 (revision 203394) @@ -1,112 +1,112 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_SECCREATE 3 .Os .Sh NAME .Nm rpc_gss_seccreate .Nd "create a security context using the RPCSEC_GSS protocol" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft AUTH * .Fo rpc_gss_seccreate .Fa "CLIENT *clnt" .Fa "const char *principal" .Fa "const char *mechanism" .Fa "rpc_gss_service_t service" .Fa "const char *qop" .Fa "rpc_gss_options_req_t *options_req" .Fa "rpc_gss_options_ret_t *options_ret" .Fc .Sh DESCRIPTION This function is used to establish a security context between an application and a remote peer using the RPSEC_GSS protocol. .Sh PARAMETERS .Bl -tag .It clnt An RPC handle which is connected to the remote peer .It principal The name of the service principal on the remote peer. For instance, a principal such as .Qq nfs@server.example.com might be used by an application which needs to contact an NFS server .It mechanism The desired mechanism for this security context. The value of mechanism should be the name of one of the security mechanisms listed in /etc/gss/mech. .It service Type of service requested. .Bl -tag .It rpc_gss_svc_default The default - typically the same as .Dv rpc_gss_svc_none . .It rpc_gss_svc_none RPC headers only are integrity protected by a checksum. .It rpc_gss_svc_integrity RPC headers and data are integrity protected by a checksum. .It rpc_gss_svc_privacy RPC headers are integrity protected by a checksum and data is encrypted. .El .It qop Desired quality of protection or NULL for the default. Available values are lised in /etc/gss/qop .It options_req Extra security context options to be passed to the underlying GSS-API mechanism. Pass .Dv NULL to supply default values. .It options_ret Various values returned by the underlying GSS-API mechanism. Pass .Dv NULL if these values are not required. .El .Sh RETURN VALUES If the security context was created successfully, a pointer to an .Vt AUTH structure that represents the context is returned. To use this security context for subsequent RPC calls, set .Va clnt->cl_auth to this value. .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr mech 5 , .Xr qop 5 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_set_callback.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_set_callback.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_set_callback.3 (revision 203394) @@ -1,115 +1,115 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_SET_CALLBACK 3 .Os .Sh NAME .Nm rpc_gss_set_callback .Nd "Register a security context creation callback" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fo (*callback) .Fa "struct svc_req *req" .Fa "gss_cred_id_t deleg" .Fa "gss_ctx_id_t gss_context" .Fa "rpc_gss_lock_t *lock" .Fa "void **cookie" .Fc .Ft bool_t .Fn rpc_gss_set_callback "rpc_gss_callback_t *cb" .Sh DESCRIPTION Register a function which will be called when new security contexts are created on a server. This function will be called on the first RPC request which uses that context and has the opportunity of rejecting the request (for instance after matching the request credentials to an access control list). To accept the new security context, the callback should return .Dv TRUE , otherwise .Dv FALSE . If the callback accepts a context, it becomes responsible for the lifetime of the delegated client credentials (if any). .Pp It is also possible to 'lock' the values of service and quality of protection used by the context. If a context is locked, any subsequent requests which use different values for service and quality of protection will be rejected. .Sh PARAMETERS .Bl -tag .It cb A structure containing the RPC program and version for this callback and a function which will be called when new contexts are created for ths given RPC program and version .It req The RPC request using the new context .It deleg GSS-APi delegated credentials (if any) .It gss_context The GSS-API context .It lock A structure used to enforce a particular QOP and service. Set .Fa lock->locked to .Dv TRUE to lock the service and QOP values .It cookie The callback function may set .Fa *cookie to any pointer sized value. This value can be accessed during the lifetime of the context via .Fn rpc_gss_getcred . .El .Sh RETURN VALUES Returns .Dv TRUE if the callback was registered successfully or .Dv FALSE otherwise .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpc_gss_getcred 3 .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . .Sh BUGS There is no mechanism for informing a server when a security context has been deleted. This makes it difficult to allocate resources (e.g. to return via the callback's .Fa cookie argument). Index: stable/8/lib/librpcsec_gss/rpc_gss_set_defaults.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_set_defaults.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_set_defaults.3 (revision 203394) @@ -1,70 +1,70 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_SET_DEFAULTS 3 .Os .Sh NAME .Nm rpc_gss_set_defaults .Nd "set service and quality of protection" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fo rpc_gss_set_defaults .Fa "AUTH *auth" .Fa "rpc_gss_service_t service" .Fa "const char *qop" .Fc .Sh DESCRIPTION Set the service and quality of protection to be used for RPC requests. The new values apply for the rest of the lifetime of the context (unless changed again with this function). .Sh PARAMETERS .Bl -tag .It service The service type to use for subsequent RPC requests .It qop The quality of protection to use or NULL for the default .El .Sh RETURN VALUES Returns .Dv TRUE if the values were set .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_set_svc_name.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_set_svc_name.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_set_svc_name.3 (revision 203394) @@ -1,87 +1,87 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_SET_SVC_NAME 3 .Os .Sh NAME .Nm rpc_gss_set_svc_name .Nd "Associate a GSS-API service principal with an RPC service" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft bool_t .Fo rpc_gss_set_svc_name .Fa "const char *principal" .Fa "const char *mechanism" .Fa "u_int req_time" .Fa "u_int program" .Fa "u_int version" .Fc .Sh DESCRIPTION This function registers a service principal which will be used to authenticate RPCSEC_GSS security contexts for a given RPC program and version. .Sh PARAMETERS .Bl -tag .It principal A string representing the service principal in the form .Qq service@hostname .It mechanim The name of the security mechanism .It req_time The time in seconds that the service credentials should remain valid. See .Xr gss_acquire_cred 3 for more details. principal. .It program RPC program number for this service .It version RPC program version for this service .El .Sh RETURN VALUES Returns .Dv TRUE if the service principal was registered or .Dv FALSE otherwise. .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr gss_acquire_cred 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpc_gss_svc_max_data_length.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpc_gss_svc_max_data_length.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpc_gss_svc_max_data_length.3 (revision 203394) @@ -1,64 +1,64 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_SVC_MAX_DATA_LENGTH 3 .Os .Sh NAME .Nm rpc_gss_svc_max_data_length .Nd "calculate maximum data size" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Ft int .Fn rpc_gss_svc_max_data_length "struct svc_req *req" "int max_tp_unit_len" .Sh DESCRIPTION Calculate the maximum message size that will fit into a packet of size .Fa max_tp_unit_len , given the current service and QoP setting. .Sh PARAMETERS .Bl -tag .It req An RPC request .It max_tp_unit_len Maximum packet size of the underlying transport protocol .El .Sh RETURN VALUES The maximum message size that can be encoded .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +function first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss/rpcsec_gss.3 =================================================================== --- stable/8/lib/librpcsec_gss/rpcsec_gss.3 (revision 203393) +++ stable/8/lib/librpcsec_gss/rpcsec_gss.3 (revision 203394) @@ -1,230 +1,230 @@ .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/ .\" Authors: Doug Rabson .\" Developed with Red Inc: Alfred Perlstein .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ -.Dd July 4, 2008 +.Dd January 26, 2010 .Dt RPC_GSS_SECCREATE 3 .Os .Sh NAME .Nm RPCSEC_GSS .Nd "GSS-API based authentication for RPC" .Sh LIBRARY .Lb librpcsec_gss .Sh SYNOPSIS .In rpc/rpcsec_gss.h .Sh DESCRIPTION .Nm is a security mechanism for the RPC protocol. It uses the Generic Security Service API (GSS-API) to establish a security context between a client and a server and to ensure that all subsequent communication between client and server are properly authenticated. Optionally, extra protection can be applied to the connection. The integrity service uses checksums to ensure that all data sent by a peer is recieved without modification. The privacy service uses encryption to ensure that no third party can access the data for a connection. .Pp To use this system, an application must first use .Fn rpc_gss_seccreate to establish a security context. .Sh DATA STRUCTURES Data structures used by .Nm appear below. .Bl -tag -width "MMMM" .It Vt rpc_gss_service_t This type defines the types of security service required for .Fn rpc_gss_seccreate . .Bd -literal typedef enum { rpc_gss_svc_default = 0, rpc_gss_svc_none = 1, rpc_gss_svc_integrity = 2, rpc_gss_svc_privacy = 3 } rpc_gss_service_t; .Ed .It Vt rpc_gss_options_ret_t This structure contains various optional values which are used while creating a security contect. .Bd -literal typedef struct { int req_flags; /* GSS request bits */ int time_req; /* requested lifetime */ gss_cred_id_t my_cred; /* GSS credential */ gss_channel_bindings_t input_channel_bindings; } rpc_gss_options_req_t; .Ed .It Vt rpc_gss_options_ret_t Various details of the created security context are returned using this structure. .Bd -literal typedef struct { int major_status; int minor_status; u_int rpcsec_version; int ret_flags; int time_req; gss_ctx_id_t gss_context; char actual_mechanism[MAX_GSS_MECH]; } rpc_gss_options_ret_t; .Ed .It Vt rpc_gss_principal_t This type is used to refer to an client principal which is represented in GSS-API exported name form (see .Xr gss_export_name 3 for more details). Names in this format may be stored in access control lists or compared with other names in exported name form. This structure is returned by .Fn rpc_gss_get_principal_name and is also referenced by the .Vt rpc_gss_rawcred_t structure. .Bd -literal typedef struct { int len; char name[1]; } *rpc_gss_principal_t; .Ed .It Vt rpc_gss_rawcred_t This structure is used to access the raw credentions associated with a security context. .Bd -literal typedef struct { u_int version; /* RPC version number */ const char *mechanism; /* security mechanism */ const char *qop; /* quality of protection */ rpc_gss_principal_t client_principal; /* client name */ const char *svc_principal; /* server name */ rpc_gss_service_t service; /* service type */ } rpc_gss_rawcred_t; .Ed .It Vt rpc_gss_ucred_t Unix credentials which are derived form the raw credentials, accessed via .Fn rpc_gss_getcred . .Bd -literal typedef struct { uid_t uid; /* user ID */ gid_t gid; /* group ID */ short gidlen; gid_t *gidlist; /* list of groups */ } rpc_gss_ucred_t; .Ed .It Vt rpc_gss_lock_t Structure used to enforce a particular QOP and service. .Bd -literal typedef struct { bool_t locked; rpc_gss_rawcred_t *raw_cred; } rpc_gss_lock_t; .Ed .It Vt rpc_gss_callback_t Callback structure used by .Fn rpc_gss_set_callback . .Bd -literal typedef struct { u_int program; /* RPC program number */ u_int version; /* RPC version number */ /* user defined callback */ bool_t (*callback)(struct svc_req *req, gss_cred_id_t deleg, gss_ctx_id_t gss_context, rpc_gss_lock_t *lock, void **cookie); } rpc_gss_callback_t; .Ed .It Vt rpc_gss_error_t Structure used to return error information by .Fn rpc_gss_get_error . .Bd -literal typedef struct { int rpc_gss_error; int system_error; /* same as errno */ } rpc_gss_error_t; /* * Values for rpc_gss_error */ #define RPC_GSS_ER_SUCCESS 0 /* no error */ #define RPC_GSS_ER_SYSTEMERROR 1 /* system error */ .Ed .Sh INDEX .Bl -tag -width "MMMM" .It Xr rpc_gss_seccreate 3 Create a new security context .It Xr rpc_gss_set_defaults 3 Set service and quality of protection for a context .It Xr rpc_gss_max_data_length 3 Calculate maximum client message sizes. .It Xr rpc_gss_get_error 3 Get details of the last error .It Xr rpc_gss_mech_to_oid 3 Convert a mechanism name to the corresponding GSS-API oid. .It Xr rpc_gss_oid_to_mech 3 Convert a GSS-API oid to a mechanism name .It Xr rpc_gss_qop_to_num 3 Convert a quality of protection name to the corresponding number .It Xr rpc_gss_get_mechanisms 3 Get a list of security mechanisms. .It Xr rpc_gss_get_mech_info 3 Return extra information about a security mechanism .It Xr rpc_gss_get_versions 3 Return the maximum and minimum supported versions of the .Nm protocol .It Xr rpc_gss_is_installed 3 Query for the presence of a particular security mechanism .It Xr rpc_gss_set_svc_name 3 Set the name of a service principal which matches a given RPC program plus version pair .It Xr rpc_gss_getcred 3 Get credential details for the security context of an RPC request .It Xr rpc_gss_set_callback 3 Install a callback routine which is called on the server when new security contexts are created .It Xr rpc_gss_get_principal_name 3 Create a client principal name from various strings .It Xr rpc_gss_svc_max_data_length 3 Calculate maximum server message sizes. .El .Sh SEE ALSO .Xr rpc 3 , .Xr gssapi 3 , .Xr gss_export_name 3 , .Xr mech 5 , .Xr qop 5 , .Xr rpcset_gss 3 .Sh HISTORY The .Nm -manual page example first appeared in +library first appeared in .Fx 8.0 . .Sh AUTHORS This manual page was written by .An Doug Rabson Aq dfr@FreeBSD.org . Index: stable/8/lib/librpcsec_gss =================================================================== --- stable/8/lib/librpcsec_gss (revision 203393) +++ stable/8/lib/librpcsec_gss (revision 203394) Property changes on: stable/8/lib/librpcsec_gss ___________________________________________________________________ Modified: svn:mergeinfo ## -0,0 +0,1 ## Merged /head/lib/librpcsec_gss:r203025-203026