osip_www_authenticate.h

Go to the documentation of this file.

/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001-2012 Aymeric MOIZARD amoizard@antisip.com
  
  This 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.
  
  This 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 along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/


#ifndef _OSIP_WWW_AUTHENTICATE_H_
#define _OSIP_WWW_AUTHENTICATE_H_


  typedef struct osip_www_authenticate osip_www_authenticate_t;

  struct osip_www_authenticate
  {
    char *auth_type;            
    char *realm;                
    char *domain;               
    char *nonce;                
    char *opaque;               
    char *stale;                
    char *algorithm;            
    char *qop_options;          
    char *auth_param;           
  };


#ifdef __cplusplus
extern "C"
{
#endif

  int osip_www_authenticate_init (osip_www_authenticate_t ** header);
  int osip_www_authenticate_parse (osip_www_authenticate_t * header, const char *hvalue);
  int osip_www_authenticate_to_str (const osip_www_authenticate_t * header, char **dest);
  void osip_www_authenticate_free (osip_www_authenticate_t * header);
  int osip_www_authenticate_clone (const osip_www_authenticate_t * header,
                              osip_www_authenticate_t ** dest);

  char *osip_www_authenticate_get_auth_type (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_auth_type (osip_www_authenticate_t * header,
                                      char *value);
  char *osip_www_authenticate_get_realm (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_realm (osip_www_authenticate_t * header, char *value);
  char *osip_www_authenticate_get_domain (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_domain (osip_www_authenticate_t * header, char *value);
  char *osip_www_authenticate_get_nonce (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_nonce (osip_www_authenticate_t * header, char *value);
  char *osip_www_authenticate_get_opaque (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_opaque (osip_www_authenticate_t * header, char *value);
  char *osip_www_authenticate_get_stale (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_stale (osip_www_authenticate_t * header, char *value);
#define osip_www_authenticate_set_stale_true(header) osip_www_authenticate_set_stale(header,osip_strdup("true"))

#define osip_www_authenticate_set_stale_false(header) osip_www_authenticate_set_stale(header,osip_strdup("false"))

  char *osip_www_authenticate_get_algorithm (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_algorithm (osip_www_authenticate_t * header,
                                      char *value);
#define osip_www_authenticate_set_algorithm_MD5(header) osip_www_authenticate_set_algorithm(header,osip_strdup("MD5"))

  char *osip_www_authenticate_get_qop_options (osip_www_authenticate_t * header);
  void osip_www_authenticate_set_qop_options (osip_www_authenticate_t * header,
                                        char *value);

#ifdef __cplusplus
}
#endif

#endif