stun_auth.h

Go to the documentation of this file.

/* $Id: stun_auth.h 3553 2011-05-05 06:14:19Z nanang $ */
/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJNATH_STUN_AUTH_H__
#define __PJNATH_STUN_AUTH_H__

#include <pjnath/stun_msg.h>


PJ_BEGIN_DECL


/* **************************************************************************/
typedef enum pj_stun_auth_type
{ 
    PJ_STUN_AUTH_NONE = 0,

    PJ_STUN_AUTH_SHORT_TERM = 1,

    PJ_STUN_AUTH_LONG_TERM = 2

} pj_stun_auth_type;


typedef enum pj_stun_auth_cred_type
{
    PJ_STUN_AUTH_CRED_STATIC,

    PJ_STUN_AUTH_CRED_DYNAMIC

} pj_stun_auth_cred_type;


typedef enum pj_stun_passwd_type
{
    PJ_STUN_PASSWD_PLAIN    = 0,

    PJ_STUN_PASSWD_HASHED = 1

} pj_stun_passwd_type;


typedef struct pj_stun_auth_cred
{
    pj_stun_auth_cred_type      type;

    union 
    {
        struct
        {
            pj_str_t            realm;

            pj_str_t            username;

            pj_stun_passwd_type data_type;

            pj_str_t            data;

            pj_str_t            nonce;

        } static_cred;

        struct
        {
            void *user_data;

            pj_status_t (*get_auth)(void *user_data,
                                    pj_pool_t *pool,
                                    pj_str_t *realm,
                                    pj_str_t *nonce);

            pj_status_t (*get_cred)(const pj_stun_msg *msg,
                                    void *user_data,
                                    pj_pool_t *pool,
                                    pj_str_t *realm,
                                    pj_str_t *username,
                                    pj_str_t *nonce,
                                    pj_stun_passwd_type *data_type,
                                    pj_str_t *data);

            pj_status_t (*get_password)(const pj_stun_msg *msg,
                                        void *user_data, 
                                        const pj_str_t *realm,
                                        const pj_str_t *username,
                                        pj_pool_t *pool,
                                        pj_stun_passwd_type *data_type,
                                        pj_str_t *data);

            pj_bool_t   (*verify_nonce)(const pj_stun_msg *msg,
                                        void *user_data,
                                        const pj_str_t *realm,
                                        const pj_str_t *username,
                                        const pj_str_t *nonce);

        } dyn_cred;

    } data;

} pj_stun_auth_cred;


typedef struct pj_stun_req_cred_info
{
    pj_str_t    realm;

    pj_str_t    username;

    pj_str_t    nonce;

    pj_str_t    auth_key;

} pj_stun_req_cred_info;


PJ_DECL(void) pj_stun_auth_cred_dup(pj_pool_t *pool,
                                      pj_stun_auth_cred *dst,
                                      const pj_stun_auth_cred *src);

PJ_DECL(void) pj_stun_req_cred_info_dup(pj_pool_t *pool,
                                        pj_stun_req_cred_info *dst,
                                        const pj_stun_req_cred_info *src);


PJ_DECL(void) pj_stun_create_key(pj_pool_t *pool,
                                 pj_str_t *key,
                                 const pj_str_t *realm,
                                 const pj_str_t *username,
                                 pj_stun_passwd_type data_type,
                                 const pj_str_t *data);

PJ_DECL(pj_status_t) pj_stun_authenticate_request(const pj_uint8_t *pkt,
                                                  unsigned pkt_len,
                                                  const pj_stun_msg *msg,
                                                  pj_stun_auth_cred *cred,
                                                  pj_pool_t *pool,
                                                  pj_stun_req_cred_info *info,
                                                  pj_stun_msg **p_response);


PJ_DECL(pj_bool_t) pj_stun_auth_valid_for_msg(const pj_stun_msg *msg);


PJ_DECL(pj_status_t) pj_stun_authenticate_response(const pj_uint8_t *pkt,
                                                   unsigned pkt_len,
                                                   const pj_stun_msg *msg,
                                                   const pj_str_t *key);


PJ_END_DECL


#endif  /* __PJNATH_STUN_AUTH_H__ */