contrib/openpam/lib/pam_end.c

   1 /*-
   2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
   3  * All rights reserved.
   4  *
   5  * This software was developed for the FreeBSD Project by ThinkSec AS and
   6  * Network Associates Laboratories, the Security Research Division of
   7  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
   8  * ("CBOSS"), as part of the DARPA CHATS research program.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. The name of the author may not be used to endorse or promote
  19  *    products derived from this software without specific prior written
  20  *    permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $P4: //depot/projects/openpam/lib/pam_end.c#14 $
  35  */
  36
  37 #include <stdlib.h>
  38
  39 #include <security/pam_appl.h>
  40
  41 #include "openpam_impl.h"
  42
  43 /*
  44  * XSSO 4.2.1
  45  * XSSO 6 page 42
  46  *
  47  * Terminate the PAM transaction
  48  */
  49
  50 int
  51 pam_end(pam_handle_t *pamh,
  52         int status)
  53 {
  54         pam_data_t *dp;
  55         int i;
  56
  57         ENTER();
  58         if (pamh == NULL)
  59                 RETURNC(PAM_SYSTEM_ERR);
  60
  61         /* clear module data */
  62         while ((dp = pamh->module_data) != NULL) {
  63                 if (dp->cleanup)
  64                         (dp->cleanup)(pamh, dp->data, status);
  65                 pamh->module_data = dp->next;
  66                 FREE(dp->name);
  67                 FREE(dp);
  68         }
  69
  70         /* clear environment */
  71         while (pamh->env_count) {
  72                 --pamh->env_count;
  73                 FREE(pamh->env[pamh->env_count]);
  74         }
  75         FREE(pamh->env);
  76
  77         /* clear chains */
  78         openpam_clear_chains(pamh->chains);
  79
  80         /* clear items */
  81         for (i = 0; i < PAM_NUM_ITEMS; ++i)
  82                 pam_set_item(pamh, i, NULL);
  83
  84         FREE(pamh);
  85
  86         RETURNC(PAM_SUCCESS);
  87 }
  88
  89 /*
  90  * Error codes:
  91  *
  92  *      PAM_SYSTEM_ERR
  93  */
  94
  95 /**
  96  * The =pam_end function terminates a PAM transaction and destroys the
  97  * corresponding PAM context, releasing all resources allocated to it.
  98  *
  99  * The =status argument should be set to the error code returned by the
 100  * last API call before the call to =pam_end.
 101  */