property.c

Go to the documentation of this file.

/* property.c --- Callback property handling.
 * Copyright (C) 2004-2022 Simon Josefsson
 *
 * This file is part of GNU SASL Library.
 *
 * GNU SASL Library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * GNU SASL Library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License License along with GNU SASL Library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */
 
#include "internal.h"
 
static char **
map (Gsasl_session * sctx, Gsasl_property prop)
{
  char **p = NULL;
 
  if (!sctx)
    return NULL;
 
  switch (prop)
    {
    case GSASL_ANONYMOUS_TOKEN:
      p = &sctx->anonymous_token;
      break;
 
    case GSASL_SERVICE:
      p = &sctx->service;
      break;
 
    case GSASL_HOSTNAME:
      p = &sctx->hostname;
      break;
 
    case GSASL_AUTHID:
      p = &sctx->authid;
      break;
 
    case GSASL_AUTHZID:
      p = &sctx->authzid;
      break;
 
    case GSASL_PASSWORD:
      p = &sctx->password;
      break;
 
    case GSASL_PASSCODE:
      p = &sctx->passcode;
      break;
 
    case GSASL_PIN:
      p = &sctx->pin;
      break;
 
    case GSASL_SUGGESTED_PIN:
      p = &sctx->suggestedpin;
      break;
 
    case GSASL_GSSAPI_DISPLAY_NAME:
      p = &sctx->gssapi_display_name;
      break;
 
    case GSASL_REALM:
      p = &sctx->realm;
      break;
 
    case GSASL_DIGEST_MD5_HASHED_PASSWORD:
      p = &sctx->digest_md5_hashed_password;
      break;
 
    case GSASL_QOPS:
      p = &sctx->qops;
      break;
 
    case GSASL_QOP:
      p = &sctx->qop;
      break;
 
    case GSASL_SCRAM_ITER:
      p = &sctx->scram_iter;
      break;
 
    case GSASL_SCRAM_SALT:
      p = &sctx->scram_salt;
      break;
 
    case GSASL_SCRAM_SALTED_PASSWORD:
      p = &sctx->scram_salted_password;
      break;
 
    case GSASL_SCRAM_SERVERKEY:
      p = &sctx->scram_serverkey;
      break;
 
    case GSASL_SCRAM_STOREDKEY:
      p = &sctx->scram_storedkey;
      break;
 
    case GSASL_CB_TLS_UNIQUE:
      p = &sctx->cb_tls_unique;
      break;
 
    case GSASL_CB_TLS_EXPORTER:
      p = &sctx->cb_tls_exporter;
      break;
 
    case GSASL_SAML20_IDP_IDENTIFIER:
      p = &sctx->saml20_idp_identifier;
      break;
 
    case GSASL_SAML20_REDIRECT_URL:
      p = &sctx->saml20_redirect_url;
      break;
 
    case GSASL_OPENID20_REDIRECT_URL:
      p = &sctx->openid20_redirect_url;
      break;
 
    case GSASL_OPENID20_OUTCOME_DATA:
      p = &sctx->openid20_outcome_data;
      break;
 
      /* If you add anything here, remember to change change
         gsasl_finish() in xfinish.c and Gsasl_session in
         internal.h.  */
 
    default:
      break;
    }
 
  return p;
}
 
/**
 * gsasl_property_free:
 * @sctx: session handle.
 * @prop: enumerated value of %Gsasl_property type to clear
 *
 * Deallocate associated data with property @prop in session handle.
 * After this call, gsasl_property_fast(@sctx, @prop) will always
 * return NULL.
 *
 * Since: 2.0.0
 **/
void
gsasl_property_free (Gsasl_session * sctx, Gsasl_property prop)
{
  char **p = map (sctx, prop);
 
  if (p)
    {
      free (*p);
      *p = NULL;
    }
}
 
/**
 * gsasl_property_set:
 * @sctx: session handle.
 * @prop: enumerated value of Gsasl_property type, indicating the
 *        type of data in @data.
 * @data: zero terminated character string to store.
 *
 * Make a copy of @data and store it in the session handle for the
 * indicated property @prop.
 *
 * You can immediately deallocate @data after calling this function,
 * without affecting the data stored in the session handle.
 *
 * Return value: %GSASL_OK iff successful, otherwise
 * %GSASL_MALLOC_ERROR.
 *
 * Since: 0.2.0
 **/
int
gsasl_property_set (Gsasl_session * sctx, Gsasl_property prop,
            const char *data)
{
  return gsasl_property_set_raw (sctx, prop, data, data ? strlen (data) : 0);
}
 
/**
 * gsasl_property_set_raw:
 * @sctx: session handle.
 * @prop: enumerated value of Gsasl_property type, indicating the
 *        type of data in @data.
 * @data: character string to store.
 * @len: length of character string to store.
 *
 * Make a copy of @len sized @data and store a zero terminated version
 * of it in the session handle for the indicated property @prop.
 *
 * You can immediately deallocate @data after calling this function,
 * without affecting the data stored in the session handle.
 *
 * Except for the length indicator, this function is identical to
 * gsasl_property_set.
 *
 * Return value: %GSASL_OK iff successful, otherwise
 * %GSASL_MALLOC_ERROR.
 *
 * Since: 0.2.0
 **/
int
gsasl_property_set_raw (Gsasl_session * sctx, Gsasl_property prop,
            const char *data, size_t len)
{
  char **p = map (sctx, prop);
 
  if (p)
    {
      free (*p);
      if (data)
    {
      *p = malloc (len + 1);
      if (!*p)
        return GSASL_MALLOC_ERROR;
 
      memcpy (*p, data, len);
      (*p)[len] = '\0';
    }
      else
    *p = NULL;
    }
 
  return GSASL_OK;
}
 
/**
 * gsasl_property_fast:
 * @sctx: session handle.
 * @prop: enumerated value of Gsasl_property type, indicating the
 *        type of data in @data.
 *
 * Retrieve the data stored in the session handle for given property
 * @prop.
 *
 * The pointer is to live data, and must not be deallocated or
 * modified in any way.
 *
 * This function will not invoke the application callback.
 *
 * Return value: Return property value, if known, or NULL if no value
 *   known.
 *
 * Since: 0.2.0
 **/
const char *
gsasl_property_fast (Gsasl_session * sctx, Gsasl_property prop)
{
  char **p = map (sctx, prop);
 
  if (p)
    return *p;
 
  return NULL;
}
 
/**
 * gsasl_property_get:
 * @sctx: session handle.
 * @prop: enumerated value of Gsasl_property type, indicating the
 *        type of data in @data.
 *
 * Retrieve the data stored in the session handle for given property
 * @prop, possibly invoking the application callback to get the value.
 *
 * The pointer is to live data, and must not be deallocated or
 * modified in any way.
 *
 * This function will invoke the application callback, using
 * gsasl_callback(), when a property value is not known.
 *
 * Return value: Return data for property, or NULL if no value known.
 *
 * Since: 0.2.0
 **/
const char *
gsasl_property_get (Gsasl_session * sctx, Gsasl_property prop)
{
  const char *p = gsasl_property_fast (sctx, prop);
 
  if (!p)
    {
      gsasl_callback (NULL, sctx, prop);
      p = gsasl_property_fast (sctx, prop);
    }
 
  return p;
}