optstr(9) [netbsd man page]

OPTSTR(9)						   BSD Kernel Developer's Manual						 OPTSTR(9)

NAME

     optstr_get -- Options string management

SYNOPSIS

     #include <sys/optstr.h>

     bool
     optstr_get(const char *optstr, const char *key, char *buf, size_t bufsize);

DESCRIPTION

     An options string is a list of key/value pairs represented in textual form.  Each pair is expressed as ''key=value'' and is separated from
     other pairs by one or more spaces.  For example:

     key1=value1 key2=value2 key3=value3

     Options strings are used to pass information between userland programs and the kernel in a binary-agnostic way.  This makes them endianness
     and ABI independent.

FUNCTIONS

     The following functions are provided to manage options strings:

     optstr_get(optstr, key, buf, bufsize)
	      Scans the optstr options string looking for the key key and stores its value in the buffer pointed to by buf copying a maximum of
	      bufsize bytes.  Returns 'true' if the key was found or 'false' otherwise, in which case buf is left unmodified.

CODE REFERENCES

     The options string management functions are implemented within the files sys/kern/subr_optstr.c and sys/sys/optstr.h.

HISTORY

     Options strings appeared in NetBSD 4.0.

BSD
								  August 11, 2007							       BSD

OPENPAM_SUBST(3)					   BSD Library Functions Manual 					  OPENPAM_SUBST(3)

NAME

     openpam_subst -- substitute PAM item values in a string

LIBRARY

     Pluggable Authentication Module Library (libpam, -lpam)

SYNOPSIS

     #include <sys/types.h>
     #include <security/pam_appl.h>
     #include <security/openpam.h>

     int
     openpam_subst(const pam_handle_t *pamh, char *buf, size_t *bufsize, const char *template);

DESCRIPTION

     The openpam_subst() function expands a string, substituting PAM item values for all occurrences of specific substitution codes.  The template
     argument points to the initial string.  The result is stored in the buffer pointed to by the buf argument; the bufsize argument specifies the
     size of that buffer.  The actual size of the resulting string, including the terminating NUL character, is stored in the location pointed to
     by the bufsize argument.

     If buf is NULL, or if the buffer is too small to hold the expanded string, bufsize is updated to reflect the amount of space required to hold
     the entire string, and openpam_subst() returns PAM_TRY_AGAIN.

     If openpam_subst() fails for any other reason, the bufsize argument is untouched, but part of the buffer may still have been overwritten.

     Substitution codes are introduced by a percent character and correspond to PAM items:

     %H 		 Replaced by the current value of the PAM_RHOST item.

     %h 		 Replaced by the current value of the PAM_HOST item.

     %s 		 Replaced by the current value of the PAM_SERVICE item.

     %t 		 Replaced by the current value of the PAM_TTY item.

     %U 		 Replaced by the current value of the PAM_RUSER item.

     %u 		 Replaced by the current value of the PAM_USER item.

RETURN VALUES

     The openpam_subst() function returns one of the following values:

     [PAM_SYSTEM_ERR]	 System error.

     [PAM_TRY_AGAIN]	 Try again.

SEE ALSO

     pam(3), pam_get_authtok(3), pam_get_item(3), pam_get_user(3), pam_strerror(3)

STANDARDS

     The openpam_subst() function is an OpenPAM extension.

AUTHORS

     The openpam_subst() function and this manual page were developed by Dag-Erling Smorgrav <des@des.no>.

BSD
								September 12, 2014							       BSD