PAMSETDATA(3) Linux-PAM Manual PAMSETDATA(3)

NAME
       pamsetdata - set module internal data

SYNOPSIS
       ##iinncclluuddee <>

       iinntt ppaammsseettddaattaa((ppaammhhaannddlleett **pamh,, ccoonnsstt cchhaarr **moduledataname,,
                        vvooiidd **data,,
                        vvooiidd (*cleanup)(pamhandlet *pamh, void *data, int errorstatus)));;

DESCRIPTION
       The ppaammsseettddaattaa function associates a pointer to an object with the
       (hopefully) unique string moduledataname in the PAM context specified
       by the pamh argument.

       PAM modules may be dynamically loadable objects. In general such files
       should not contain static variables. This function and its counterpart
       ppaammggeettddaattaa(3), provide a mechanism for a module to associate some
       data with the handle pamh. Typically a module will call the
       ppaammsseettddaattaa function to register some data under a (hopefully) unique
       moduledataname. The data is available for use by other modules too
       but not by an application. Since this functions stores only a pointer
       to the data, the module should not modify or free the content of it.

       The function cclleeaannuupp(()) is associated with the data and, if non-NULL, it
       is called when this data is over-written or following a call to
       ppaammeenndd(3).

       The errorstatus argument is used to indicate to the module the sort of
       action it is to take in cleaning this data item. As an example,
       Kerberos creates a ticket file during the authentication phase, this
       file might be associated with a data item. When ppaammeenndd(3) is called by
       the module, the errorstatus carries the return value of the
       ppaammaauutthheennttiiccaattee(3) or other libpam function as appropriate. Based on
       this value the Kerberos module may choose to delete the ticket file
       (authentication failure) or leave it in place.

       The errorstatus may have been logically OR'd with either of the
       following two values:

       PAMDATAREPLACE
          When a data item is being replaced (through a second call to
          ppaammsseettddaattaa) this mask is used. Otherwise, the call is assumed to
          be from ppaammeenndd(3).

       PAMDATASILENT
          Which indicates that the process would prefer to perform the
          cclleeaannuupp(()) quietly. That is, discourages logging/messages to the
          user.

RETURN VALUES
       PAMBUFERR
          Memory buffer error.

       PAMSUCCESS
          Data was successful stored.

       PAMSYSTEMERR
          A NULL pointer was submitted as PAM handle or the function was
          called by an application.

SEE ALSO
       ppaammeenndd(3), ppaammggeettddaattaa(3), ppaammssttrreerrrroorr(3)



Linux-PAM Manual                  06/27/2006                   PAMSETDATA(3)