contrib/openpam/lib/pam_end.c

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