Changeset 64 in openpam for trunk/doc/man


Ignore:
Timestamp:
Feb 18, 2002, 7:34:54 PM (19 years ago)
Author:
Dag-Erling Smørgrav
Message:

Regenerate, now with actual content.

Sponsored by: DARPA, NAI Labs

Location:
trunk/doc/man
Files:
8 added
26 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/man/pam.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM 3
    3838.Os
    … …  
    8383.Fn pam_get_authtok "pam_handle_t *pamh" "const char **authtok" "const char *prompt"
    8484.Ft int
    85 .Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "void **data"
     85.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "const void **data"
    8686.Ft int
    8787.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "const void **item"
    … …  
    120120.Sh DESCRIPTION
    121121.Sh RETURN VALUES
     122The following return codes are defined in the
     123.In security/pam_constants.h
     124header:
     125.Bl -tag -width 18n
     126.It Bq Er PAM_ABORT
     127General failure.
     128.It Bq Er PAM_ACCT_EXPIRED
     129User accound has expired.
     130.It Bq Er PAM_AUTHINFO_UNAVAIL
     131Authentication information is unavailable.
     132.It Bq Er PAM_AUTHTOK_DISABLE_AGING
     133Authentication token aging disabled.
     134.It Bq Er PAM_AUTHTOK_ERR
     135Authentication token failure.
     136.It Bq Er PAM_AUTHTOK_EXPIRED
     137Password has expired.
     138.It Bq Er PAM_AUTHTOK_LOCK_BUSY
     139Authentication token lock busy.
     140.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
     141Failed to recover old authentication token.
     142.It Bq Er PAM_AUTH_ERR
     143Authentication error.
     144.It Bq Er PAM_BUF_ERR
     145Memory buffer error.
     146.It Bq Er PAM_CONV_ERR
     147Conversation failure.
     148.It Bq Er PAM_CRED_ERR
     149Failed to set user credentials.
     150.It Bq Er PAM_CRED_EXPIRED
     151User credentials have expired.
     152.It Bq Er PAM_CRED_INSUFFICIENT
     153Insufficient credentials.
     154.It Bq Er PAM_CRED_UNAVAIL
     155Failed to retrieve user credentials.
     156.It Bq Er PAM_DOMAIN_UNKNOWN
     157Unknown authentication domain.
     158.It Bq Er PAM_IGNORE
     159Ignore this module.
     160.It Bq Er PAM_MAXTRIES
     161Maximum number of tries exceeded.
     162.It Bq Er PAM_MODULE_UNKNOWN
     163Unknown module type.
     164.It Bq Er PAM_NEW_AUTHTOK_REQD
     165New authentication token required.
     166.It Bq Er PAM_NO_MODULE_DATA
     167Module data not found.
     168.It Bq Er PAM_OPEN_ERR
     169Failed to load module.
     170.It Bq Er PAM_PERM_DENIED
     171Permission denied.
     172.It Bq Er PAM_SERVICE_ERR
     173Error in service module.
     174.It Bq Er PAM_SESSION_ERR
     175Session failure.
     176.It Bq Er PAM_SUCCESS
     177Success.
     178.It Bq Er PAM_SYMBOL_ERR
     179Invalid symbol.
     180.It Bq Er PAM_SYSTEM_ERR
     181System error.
     182.It Bq Er PAM_TRY_AGAIN
     183Try again.
     184.It Bq Er PAM_USER_UNKNOWN
     185Unknown user.
     186.El
    122187.Sh SEE ALSO
    123188.Xr pam_acct_mgmt 3 ,

  • trunk/doc/man/pam_acct_mgmt.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_ACCT_MGMT 3
    3838.Os
    … …  
    4747.Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags"
    4848.Sh DESCRIPTION
     49No description available.
     50.Sh RETURN VALUES
    4951The
    5052.Nm
    51 function is not yet documented.
    52 .Sh RETURN VALUES
    53 The
    54 .Fn
    5553function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     54.Bl -tag -width 18n
     55.It Bq Er PAM_ABORT
     56General failure.
     57.It Bq Er PAM_ACCT_EXPIRED
     58User accound has expired.
     59.It Bq Er PAM_AUTH_ERR
     60Authentication error.
     61.It Bq Er PAM_BUF_ERR
     62Memory buffer error.
     63.It Bq Er PAM_CONV_ERR
     64Conversation failure.
     65.It Bq Er PAM_NEW_AUTHTOK_REQD
     66New authentication token required.
     67.It Bq Er PAM_PERM_DENIED
     68Permission denied.
     69.It Bq Er PAM_SERVICE_ERR
     70Error in service module.
     71.It Bq Er PAM_SYSTEM_ERR
     72System error.
     73.It Bq Er PAM_USER_UNKNOWN
     74Unknown user.
    5775.El
    5876.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     77.Xr pam 3 ,
     78.Xr pam_strerror 3
    6179.Sh STANDARDS
    6280.Rs

  • trunk/doc/man/pam_authenticate.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_AUTHENTICATE 3
    3838.Os
    … …  
    4747.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
    4848.Sh DESCRIPTION
     49No description available.
     50.Sh RETURN VALUES
    4951The
    5052.Nm
    51 function is not yet documented.
    52 .Sh RETURN VALUES
    53 The
    54 .Fn
    5553function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     54.Bl -tag -width 18n
     55.It Bq Er PAM_ABORT
     56General failure.
     57.It Bq Er PAM_AUTHINFO_UNAVAIL
     58Authentication information is unavailable.
     59.It Bq Er PAM_AUTH_ERR
     60Authentication error.
     61.It Bq Er PAM_BUF_ERR
     62Memory buffer error.
     63.It Bq Er PAM_CONV_ERR
     64Conversation failure.
     65.It Bq Er PAM_CRED_INSUFFICIENT
     66Insufficient credentials.
     67.It Bq Er PAM_MAXTRIES
     68Maximum number of tries exceeded.
     69.It Bq Er PAM_PERM_DENIED
     70Permission denied.
     71.It Bq Er PAM_SERVICE_ERR
     72Error in service module.
     73.It Bq Er PAM_SYSTEM_ERR
     74System error.
     75.It Bq Er PAM_USER_UNKNOWN
     76Unknown user.
    5777.El
    5878.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     79.Xr pam 3 ,
     80.Xr pam_strerror 3
    6181.Sh STANDARDS
    6282.Rs

  • trunk/doc/man/pam_chauthtok.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_CHAUTHTOK 3
    3838.Os
    … …  
    4747.Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
    4848.Sh DESCRIPTION
     49No description available.
     50.Sh RETURN VALUES
    4951The
    5052.Nm
    51 function is not yet documented.
    52 .Sh RETURN VALUES
    53 The
    54 .Fn
    5553function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     54.Bl -tag -width 18n
     55.It Bq Er PAM_ABORT
     56General failure.
     57.It Bq Er PAM_AUTHTOK_DISABLE_AGING
     58Authentication token aging disabled.
     59.It Bq Er PAM_AUTHTOK_ERR
     60Authentication token failure.
     61.It Bq Er PAM_AUTHTOK_LOCK_BUSY
     62Authentication token lock busy.
     63.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
     64Failed to recover old authentication token.
     65.It Bq Er PAM_BUF_ERR
     66Memory buffer error.
     67.It Bq Er PAM_CONV_ERR
     68Conversation failure.
     69.It Bq Er PAM_PERM_DENIED
     70Permission denied.
     71.It Bq Er PAM_SERVICE_ERR
     72Error in service module.
     73.It Bq Er PAM_SYSTEM_ERR
     74System error.
    5775.El
    5876.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     77.Xr pam 3 ,
     78.Xr pam_strerror 3
    6179.Sh STANDARDS
    6280.Rs

  • trunk/doc/man/pam_close_session.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_CLOSE_SESSION 3
    3838.Os
    … …  
    4747.Fn pam_close_session "pam_handle_t *pamh" "int flags"
    4848.Sh DESCRIPTION
     49No description available.
     50.Sh RETURN VALUES
    4951The
    5052.Nm
    51 function is not yet documented.
    52 .Sh RETURN VALUES
    53 The
    54 .Fn
    5553function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     54.Bl -tag -width 18n
     55.It Bq Er PAM_ABORT
     56General failure.
     57.It Bq Er PAM_BUF_ERR
     58Memory buffer error.
     59.It Bq Er PAM_CONV_ERR
     60Conversation failure.
     61.It Bq Er PAM_PERM_DENIED
     62Permission denied.
     63.It Bq Er PAM_SERVICE_ERR
     64Error in service module.
     65.It Bq Er PAM_SESSION_ERR
     66Session failure.
     67.It Bq Er PAM_SYSTEM_ERR
     68System error.
    5769.El
    5870.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     71.Xr pam 3 ,
     72.Xr pam_strerror 3
    6173.Sh STANDARDS
    6274.Rs

  • trunk/doc/man/pam_end.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_END 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function terminates a PAM transaction and destroys the
     52corresponding PAM context, releasing all resources allocated to it.
     53.Pp
     54The
     55.Va status
     56argument should be set to the error code returned by the
     57last API call before the call to
     58.Nm
     59.
    5260.Sh RETURN VALUES
    5361The
    54 .Fn
     62.Nm
    5563function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     64.Bl -tag -width 18n
     65.It Bq Er PAM_SYSTEM_ERR
     66System error.
    5767.El
    5868.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     69.Xr pam 3 ,
     70.Xr pam_strerror 3
    6171.Sh STANDARDS
    6272.Rs

  • trunk/doc/man/pam_error.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_ERROR 3
    3838.Os
    … …  
    4848.Sh DESCRIPTION
    4949The
    50 .Nm
    51 function is not yet documented.
     50.Xr pam_info 3
     51function displays an error message through the
     52intermediary of the given PAM context's conversation function.
     53.Pp
    5254.Sh RETURN VALUES
    5355The
    54 .Fn
     56.Nm
    5557function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     58.Bl -tag -width 18n
     59.It Bq Er PAM_BUF_ERR
     60Memory buffer error.
     61.It Bq Er PAM_CONV_ERR
     62Conversation failure.
     63.It Bq Er PAM_SYSTEM_ERR
     64System error.
    5765.El
    5866.Sh SEE ALSO
     67.Xr pam 3 ,
     68.Xr pam_info 3 ,
     69.Xr pam_prompt 3 ,
    5970.Xr pam_strerror 3 ,
    60 .Xr pam 3
     71.Xr pam_verror 3
    6172.Sh STANDARDS
    6273.Rs

  • trunk/doc/man/pam_get_authtok.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_GET_AUTHTOK 3
    3838.Os
    … …  
    4747.Fn pam_get_authtok "pam_handle_t *pamh" "const char **authtok" "const char *prompt"
    4848.Sh DESCRIPTION
     49No description available.
     50.Sh RETURN VALUES
    4951The
    5052.Nm
    51 function is not yet documented.
    52 .Sh RETURN VALUES
    53 The
    54 .Fn
    5553function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     54.Bl -tag -width 18n
     55.It Bq Er PAM_BUF_ERR
     56Memory buffer error.
     57.It Bq Er PAM_CONV_ERR
     58Conversation failure.
     59.It Bq Er PAM_SYSTEM_ERR
     60System error.
    5761.El
    5862.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     63.Xr pam 3 ,
     64.Xr pam_strerror 3
    6165.Sh STANDARDS
    6266.Rs

  • trunk/doc/man/pam_get_data.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_GET_DATA 3
    3838.Os
    … …  
    4545.In security/pam_appl.h
    4646.Ft int
    47 .Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "void **data"
     47.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "const void **data"
    4848.Sh DESCRIPTION
    4949The
    5050.Nm
    51 function is not yet documented.
     51function looks up the opaque object associated with
     52the string specified by the
     53.Va module_data_name
     54argument, in the PAM
     55context specified by the
     56.Va pamh
     57argument.
     58A pointer to the object is stored in the location pointed to by the
     59.Va data
     60argument.
     61.Pp
     62This function and its counterpart
     63.Xr pam_set_data 3
     64are useful for managing
     65data that are meaningful only to a particular service module.
    5266.Sh RETURN VALUES
    5367The
    54 .Fn
     68.Nm
    5569function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     70.Bl -tag -width 18n
     71.It Bq Er PAM_NO_MODULE_DATA
     72Module data not found.
     73.It Bq Er PAM_SYSTEM_ERR
     74System error.
    5775.El
    5876.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     77.Xr pam 3 ,
     78.Xr pam_set_data 3 ,
     79.Xr pam_strerror 3
    6180.Sh STANDARDS
    6281.Rs

  • trunk/doc/man/pam_get_item.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_GET_ITEM 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function stores a pointer to the item specified by
     52the
     53.Va item_type
     54argument in the location specified by the
     55.Va item
     56argument.
     57The item is retrieved from the PAM context specified by the
     58.Va pamh
     59argument.
     60The following item types are recognized:
     61.Bl -tag -width 18n
     62.It Dv PAM_SERVICE
     63The name of the requesting service.
     64.It Dv PAM_USER
     65The name of the user the application is trying to
     66authenticate.
     67.It Dv PAM_TTY
     68The name of the current terminal.
     69.It Dv PAM_RHOST
     70The name of the applicant's host.
     71.It Dv PAM_CONV
     72A
     73.Vt struct pam_conv
     74describing the current conversation
     75function.
     76.It Dv PAM_AUTHTOK
     77The current authentication token.
     78.It Dv PAM_OLDAUTHTOK
     79The expired authentication token.
     80.It Dv PAM_RUSER
     81The name of the applicant.
     82.It Dv PAM_USER_PROMPT
     83The prompt to use when asking the applicant for a user
     84name to authenticate as.
     85.It Dv PAM_AUTHTOK_PROMPT
     86The prompt to use when asking the applicant for an
     87authentication token.
     88.El
     89See
     90.Xr pam_start 3
     91for a description of
     92.Vt struct pam_conv .
     93.Pp
    5294.Sh RETURN VALUES
    5395The
    54 .Fn
     96.Nm
    5597function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     98.Bl -tag -width 18n
     99.It Bq Er PAM_SYMBOL_ERR
     100Invalid symbol.
     101.It Bq Er PAM_SYSTEM_ERR
     102System error.
    57103.El
    58104.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     105.Xr pam 3 ,
     106.Xr pam_set_item 3 ,
     107.Xr pam_start 3 ,
     108.Xr pam_strerror 3
    61109.Sh STANDARDS
    62110.Rs

  • trunk/doc/man/pam_get_user.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_GET_USER 3
    3838.Os
    … …  
    4747.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt"
    4848.Sh DESCRIPTION
     49No description available.
     50.Sh RETURN VALUES
    4951The
    5052.Nm
    51 function is not yet documented.
    52 .Sh RETURN VALUES
    53 The
    54 .Fn
    5553function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     54.Bl -tag -width 18n
     55.It Bq Er PAM_BUF_ERR
     56Memory buffer error.
     57.It Bq Er PAM_CONV_ERR
     58Conversation failure.
     59.It Bq Er PAM_SYSTEM_ERR
     60System error.
    5761.El
    5862.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     63.Xr pam 3 ,
     64.Xr pam_strerror 3
    6165.Sh STANDARDS
    6266.Rs

  • trunk/doc/man/pam_getenv.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_GETENV 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function returns the value of an environment variable.
     52Its semantics are similar to those of
     53.Xr getenv 3 ,
     54but it accesses the PAM
     55context's environment list instead of the application's.
     56.Pp
    5257.Sh RETURN VALUES
    5358The
    54 .Fn
    55 function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
    57 .El
     59.Nm
     60function returns
     61.Dv NULL
     62on failure.
    5863.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     64.Xr getenv 3 ,
     65.Xr pam 3 ,
     66.Xr pam_getenvlist 3 ,
     67.Xr pam_putenv 3 ,
     68.Xr pam_setenv 3
    6169.Sh STANDARDS
    6270.Rs

  • trunk/doc/man/pam_getenvlist.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_GETENVLIST 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function returns a copy of the given PAM context's
     52environment list as a pointer to an array of strings.
     53The last element in the array is
     54.Dv NULL .
     55The pointer is suitable for assignment to
     56.Va environ .
     57.Pp
     58The array and the strings it lists are allocated using
     59.Xr malloc 3 ,
     60and
     61should be released using
     62.Xr free 3
     63after use:
     64.Pp
     65.Bd -literal
     66    char **envlist, **env;
     67
     68    envlist = environ;
     69    environ = pam_getenvlist(pamh);
     70    /* do something nifty */
     71    for (env = environ; *env != NULL; env++)
     72        free(*env);
     73    free(environ);
     74    environ = envlist;
     75
    5276.Sh RETURN VALUES
    5377The
    54 .Fn
    55 function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
    57 .El
     78.Nm
     79function returns
     80.Dv NULL
     81on failure.
    5882.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     83.Xr environ 7 ,
     84.Xr free 3 ,
     85.Xr malloc 3 ,
     86.Xr pam 3 ,
     87.Xr pam_getenv 3 ,
     88.Xr pam_putenv 3 ,
     89.Xr pam_setenv 3
    6190.Sh STANDARDS
    6291.Rs

  • trunk/doc/man/pam_info.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_INFO 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function displays an informational message through the
     52intermediary of the given PAM context's conversation function.
     53.Pp
    5254.Sh RETURN VALUES
    5355The
    54 .Fn
     56.Nm
    5557function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     58.Bl -tag -width 18n
     59.It Bq Er PAM_BUF_ERR
     60Memory buffer error.
     61.It Bq Er PAM_CONV_ERR
     62Conversation failure.
     63.It Bq Er PAM_SYSTEM_ERR
     64System error.
    5765.El
    5866.Sh SEE ALSO
     67.Xr pam 3 ,
     68.Xr pam_error 3 ,
     69.Xr pam_prompt 3 ,
    5970.Xr pam_strerror 3 ,
    60 .Xr pam 3
     71.Xr pam_vinfo 3
    6172.Sh STANDARDS
    6273.Rs

  • trunk/doc/man/pam_open_session.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_OPEN_SESSION 3
    3838.Os
    … …  
    4747.Fn pam_open_session "pam_handle_t *pamh" "int flags"
    4848.Sh DESCRIPTION
     49No description available.
     50.Sh RETURN VALUES
    4951The
    5052.Nm
    51 function is not yet documented.
    52 .Sh RETURN VALUES
    53 The
    54 .Fn
    5553function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     54.Bl -tag -width 18n
     55.It Bq Er PAM_ABORT
     56General failure.
     57.It Bq Er PAM_BUF_ERR
     58Memory buffer error.
     59.It Bq Er PAM_CONV_ERR
     60Conversation failure.
     61.It Bq Er PAM_PERM_DENIED
     62Permission denied.
     63.It Bq Er PAM_SERVICE_ERR
     64Error in service module.
     65.It Bq Er PAM_SESSION_ERR
     66Session failure.
     67.It Bq Er PAM_SYSTEM_ERR
     68System error.
    5769.El
    5870.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     71.Xr pam 3 ,
     72.Xr pam_strerror 3
    6173.Sh STANDARDS
    6274.Rs

  • trunk/doc/man/pam_prompt.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_PROMPT 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function constructs a message from the specified format
     52string and arguments and passes it to the given PAM context's
     53conversation function.
     54.Pp
     55A pointer to the response, or
     56.Dv NULL
     57if the conversation function did
     58not return one, is stored in the location pointed to by the
     59.Va resp
     60argument.
     61.Pp
     62See
     63.Xr pam_vprompt 3
     64for further details.
     65.Pp
    5266.Sh RETURN VALUES
    5367The
    54 .Fn
     68.Nm
    5569function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     70.Bl -tag -width 18n
     71.It Bq Er PAM_BUF_ERR
     72Memory buffer error.
     73.It Bq Er PAM_CONV_ERR
     74Conversation failure.
     75.It Bq Er PAM_SYSTEM_ERR
     76System error.
    5777.El
    5878.Sh SEE ALSO
     79.Xr pam 3 ,
     80.Xr pam_error 3 ,
     81.Xr pam_info 3 ,
    5982.Xr pam_strerror 3 ,
    60 .Xr pam 3
     83.Xr pam_vprompt 3
    6184.Sh STANDARDS
    6285.Rs

  • trunk/doc/man/pam_putenv.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_PUTENV 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function sets a environment variable.
     52Its semantics are similar to those of
     53.Xr putenv 3 ,
     54but it modifies the PAM
     55context's environment list instead of the application's.
     56.Pp
    5257.Sh RETURN VALUES
    5358The
    54 .Fn
     59.Nm
    5560function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     61.Bl -tag -width 18n
     62.It Bq Er PAM_BUF_ERR
     63Memory buffer error.
     64.It Bq Er PAM_SYSTEM_ERR
     65System error.
    5766.El
    5867.Sh SEE ALSO
     68.Xr pam 3 ,
     69.Xr pam_getenv 3 ,
     70.Xr pam_getenvlist 3 ,
     71.Xr pam_setenv 3 ,
    5972.Xr pam_strerror 3 ,
    60 .Xr pam 3
     73.Xr putenv 3
    6174.Sh STANDARDS
    6275.Rs

  • trunk/doc/man/pam_set_data.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_SET_DATA 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function associates a pointer to an opaque object
     52with an arbitrary string specified by the
     53.Va module_data_name
     54argument,
     55in the PAM context specified by the
     56.Va pamh
     57argument.
     58.Pp
     59If not
     60.Dv NULL ,
     61the
     62.Xr cleanup 3
     63argument should point to a function
     64responsible for releasing the resources associated with the object.
     65.Pp
     66This function and its counterpart
     67.Xr pam_get_data 3
     68are useful for managing
     69data that are meaningful only to a particular service module.
    5270.Sh RETURN VALUES
    5371The
    54 .Fn
     72.Nm
    5573function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     74.Bl -tag -width 18n
     75.It Bq Er PAM_BUF_ERR
     76Memory buffer error.
     77.It Bq Er PAM_SYSTEM_ERR
     78System error.
    5779.El
    5880.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     81.Xr cleanup 3 ,
     82.Xr pam 3 ,
     83.Xr pam_get_data 3 ,
     84.Xr pam_strerror 3
    6185.Sh STANDARDS
    6286.Rs

  • trunk/doc/man/pam_set_item.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_SET_ITEM 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function sets the item specified by the
     52.Va item_type
     53argument to a copy of the object pointed to by the
     54.Va item
     55argument.
     56The item is stored in the PAM context specified by the
     57.Va pamh
     58argument.
     59See
     60.Xr pam_get_item 3
     61for a list of recognized item types.
    5262.Sh RETURN VALUES
    5363The
    54 .Fn
     64.Nm
    5565function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     66.Bl -tag -width 18n
     67.It Bq Er PAM_BUF_ERR
     68Memory buffer error.
     69.It Bq Er PAM_SYMBOL_ERR
     70Invalid symbol.
     71.It Bq Er PAM_SYSTEM_ERR
     72System error.
    5773.El
    5874.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     75.Xr pam 3 ,
     76.Xr pam_get_item 3 ,
     77.Xr pam_strerror 3
    6178.Sh STANDARDS
    6279.Rs

  • trunk/doc/man/pam_setcred.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_SETCRED 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function manages the application's credentials.
     52The operation to perform is specified by the
     53.Va flags
     54argument:
     55.Bl -tag -width 18n
     56.It PAM_ESTABLISH_CRED
     57Establish the credentials of the target user.
     58.It PAM_DELETE_CRED
     59Revoke all established credentials.
     60.It PAM_REINITIALISE_CRED
     61Fully reinitialise credentials.
     62.It PAM_REFRESH_CRED
     63Refresh credentials.
    5264.Sh RETURN VALUES
    5365The
    54 .Fn
     66.Nm
    5567function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     68.Bl -tag -width 18n
     69.It Bq Er PAM_ABORT
     70General failure.
     71.It Bq Er PAM_BUF_ERR
     72Memory buffer error.
     73.It Bq Er PAM_CONV_ERR
     74Conversation failure.
     75.It Bq Er PAM_CRED_ERR
     76Failed to set user credentials.
     77.It Bq Er PAM_CRED_EXPIRED
     78User credentials have expired.
     79.It Bq Er PAM_CRED_UNAVAIL
     80Failed to retrieve user credentials.
     81.It Bq Er PAM_PERM_DENIED
     82Permission denied.
     83.It Bq Er PAM_SERVICE_ERR
     84Error in service module.
     85.It Bq Er PAM_SYSTEM_ERR
     86System error.
     87.It Bq Er PAM_USER_UNKNOWN
     88Unknown user.
    5789.El
    5890.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     91.Xr pam 3 ,
     92.Xr pam_strerror 3
    6193.Sh STANDARDS
    6294.Rs

  • trunk/doc/man/pam_setenv.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_SETENV 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function sets a environment variable.
     52Its semantics are similar to those of
     53.Xr setenv 3 ,
     54but it modifies the PAM
     55context's environment list instead of the application's.
     56.Pp
    5257.Sh RETURN VALUES
    5358The
    54 .Fn
     59.Nm
    5560function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     61.Bl -tag -width 18n
     62.It Bq Er PAM_BUF_ERR
     63Memory buffer error.
     64.It Bq Er PAM_SYSTEM_ERR
     65System error.
    5766.El
    5867.Sh SEE ALSO
     68.Xr pam 3 ,
     69.Xr pam_getenv 3 ,
     70.Xr pam_getenvlist 3 ,
     71.Xr pam_putenv 3 ,
    5972.Xr pam_strerror 3 ,
    60 .Xr pam 3
     73.Xr setenv 3
    6174.Sh STANDARDS
    6275.Rs

  • trunk/doc/man/pam_start.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_START 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function creates and initializes a PAM context.
     52.Pp
     53The
     54.Va service
     55argument specifies the name of the policy to apply, and is
     56stored in the
     57.Dv PAM_SERVICE
     58item in the created context.
     59.Pp
     60The
     61.Va user
     62argument specifies the name of the target user - the user the
     63created context will serve to authenticate.
     64It is stored in the
     65.Dv PAM_USER
     66item in the created context.
     67.Pp
     68The
     69.Va pam_conv
     70argument points to a
     71.Vt struct pam_conv
     72describing the
     73conversation function to use.
     74This structure is defined as follows:
     75.Pp
     76.Bd -literal
     77    struct pam_conv {
     78         int   (*conv)(int, const struct pam_message **,
     79             struct pam_response **, void *);
     80         void   *appdata_ptr;
     81    };
     82
    5283.Sh RETURN VALUES
    5384The
    54 .Fn
     85.Nm
    5586function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     87.Bl -tag -width 18n
     88.It Bq Er PAM_BUF_ERR
     89Memory buffer error.
     90.It Bq Er PAM_SYSTEM_ERR
     91System error.
    5792.El
    5893.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    60 .Xr pam 3
     94.Xr pam 3 ,
     95.Xr pam_end 3 ,
     96.Xr pam_get_item 3 ,
     97.Xr pam_set_item 3 ,
     98.Xr pam_strerror 3
    6199.Sh STANDARDS
    62100.Rs

  • trunk/doc/man/pam_strerror.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_STRERROR 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function returns a pointer to a string containing a
     52textual description of the error indicated by the
     53.Va error_number
     54argument, in the context of the PAM transaction described by the
     55.Va pamh
     56argument.
    5257.Sh RETURN VALUES
    5358The
    54 .Fn
    55 function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
    57 .El
     59.Nm
     60function returns
     61.Dv NULL
     62on failure.
    5863.Sh SEE ALSO
    59 .Xr pam_strerror 3 ,
    6064.Xr pam 3
    6165.Sh STANDARDS

  • trunk/doc/man/pam_verror.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_VERROR 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function passes its arguments to
     52.Xr pam_vprompt 3
     53with a
     54.Xr style 3
     55argument of
     56.Dv PAM_ERROR_MSG ,
     57and discards the response.
     58.Pp
    5259.Sh RETURN VALUES
    5360The
    54 .Fn
     61.Nm
    5562function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     63.Bl -tag -width 18n
     64.It Bq Er PAM_BUF_ERR
     65Memory buffer error.
     66.It Bq Er PAM_CONV_ERR
     67Conversation failure.
     68.It Bq Er PAM_SYSTEM_ERR
     69System error.
    5770.El
    5871.Sh SEE ALSO
     72.Xr  3 ,
     73.Xr pam 3 ,
     74.Xr pam_error 3 ,
    5975.Xr pam_strerror 3 ,
    60 .Xr pam 3
     76.Xr pam_vinfo 3 ,
     77.Xr pam_vprompt 3
    6178.Sh STANDARDS
    6279.Rs

  • trunk/doc/man/pam_vinfo.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_VINFO 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function passes its arguments to
     52.Xr pam_vprompt 3
     53with a
     54.Xr style 3
     55argument of
     56.Dv PAM_TEXT_INFO ,
     57and discards the response.
     58.Pp
    5259.Sh RETURN VALUES
    5360The
    54 .Fn
     61.Nm
    5562function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     63.Bl -tag -width 18n
     64.It Bq Er PAM_BUF_ERR
     65Memory buffer error.
     66.It Bq Er PAM_CONV_ERR
     67Conversation failure.
     68.It Bq Er PAM_SYSTEM_ERR
     69System error.
    5770.El
    5871.Sh SEE ALSO
     72.Xr  3 ,
     73.Xr pam 3 ,
     74.Xr pam_info 3 ,
    5975.Xr pam_strerror 3 ,
    60 .Xr pam 3
     76.Xr pam_verror 3 ,
     77.Xr pam_vprompt 3
    6178.Sh STANDARDS
    6279.Rs

  • trunk/doc/man/pam_vprompt.3

    r45 r64  
    3434.\" $Id$
    3535.\"
    36 .Dd February 9, 2002
     36.Dd February 18, 2002
    3737.Dt PAM_VPROMPT 3
    3838.Os
    … …  
    4949The
    5050.Nm
    51 function is not yet documented.
     51function constructs a string from the
     52.Va fmt
     53and
     54.Va ap
     55arguments using
     56.Xr vsnprintf 3 ,
     57and passes it to the given PAM context's
     58conversation function.
     59.Pp
     60The
     61.Va style
     62argument specifies the type of interaction requested, and
     63must be one of the following:
     64.Bl -tag -width 18n
     65.It Dv PAM_PROMPT_ECHO_OFF
     66Display the message and obtain the user's response without
     67displaying it.
     68.It Dv PAM_PROMPT_ECHO_ON
     69Display the message and obtain the user's response.
     70.It Dv PAM_ERROR_MSG
     71Display the message as an error message, and do not wait
     72for a response.
     73.It Dv PAM_TEXT_INFO
     74Display the message as an informational message, and do
     75not wait for a response.
     76.El
     77A pointer to the response, or
     78.Dv NULL
     79if the conversation function did
     80not return one, is stored in the location pointed to by the
     81.Va resp
     82argument.
     83.Pp
     84The message and response should not exceed
     85.Dv PAM_MAX_MSG_SIZE
     86or
     87.Dv PAM_MAX_RESP_SIZE ,
     88respectively.
     89If they do, they may be truncated.
     90.Pp
    5291.Sh RETURN VALUES
    5392The
    54 .Fn
     93.Nm
    5594function returns one of the following values:
    56 .Bl -tag -width PAM_AUTHTOK_DISABLE_AGING
     95.Bl -tag -width 18n
     96.It Bq Er PAM_BUF_ERR
     97Memory buffer error.
     98.It Bq Er PAM_CONV_ERR
     99Conversation failure.
     100.It Bq Er PAM_SYSTEM_ERR
     101System error.
    57102.El
    58103.Sh SEE ALSO
     104.Xr pam 3 ,
     105.Xr pam_error 3 ,
     106.Xr pam_info 3 ,
     107.Xr pam_prompt 3 ,
    59108.Xr pam_strerror 3 ,
    60 .Xr pam 3
     109.Xr pam_verror 3 ,
     110.Xr pam_vinfo 3 ,
     111.Xr vsnprintf 3
    61112.Sh STANDARDS
    62113.Rs
Note: See TracChangeset for help on using the changeset viewer.