Loading...
Searching...
No Matches
auth_module.h
Go to the documentation of this file.
/*
* This file is part of the Sofia-SIP package
*
* Copyright (C) 2005 Nokia Corporation.
*
* Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
*
* 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., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
#ifndef AUTH_MODULE_H
#define AUTH_MODULE_H
#ifndef SU_TAG_H
#include <sofia-sip/su_tag.h>
#endif
#ifndef SU_WAIT_H
#include <sofia-sip/su_wait.h>
#endif
#ifndef MSG_TYPES_H
#include <sofia-sip/msg_types.h>
#endif
#ifndef URL_H
#include <sofia-sip/url.h>
#endif
#ifndef URL_TAG_H
#include <sofia-sip/url_tag.h>
#endif
SOFIA_BEGIN_DECLS
typedef struct auth_mod_t auth_mod_t;
typedef struct auth_status_t auth_status_t;
#ifdef AUTH_MAGIC_T
typedef AUTH_MAGIC_T auth_magic_t;
#else
typedef void auth_magic_t;
#endif
typedef struct auth_scheme const auth_scheme_t;
typedef struct auth_plugin_t auth_plugin_t;
typedef struct auth_splugin_t auth_splugin_t;
typedef struct auth_uplugin_t auth_uplugin_t;
typedef void auth_callback_t(auth_magic_t *, auth_status_t *);
struct auth_status_t
{
su_home_t as_home[1];
int as_status;
char const *as_phrase;
char const *as_user;
char const *as_display;
url_t const *as_user_uri; /* Return user's identity [in/out] */
char const *as_ident;
unsigned as_profile;
su_addrinfo_t *as_source;
char const *as_realm;
char const *as_domain;
char const *as_uri;
char const *as_pdomain;
char const *as_method;
void const *as_body;
isize_t as_bodylen;
msg_time_t as_nonce_issued;
unsigned as_blacklist;
unsigned as_anonymous:1;
unsigned as_stale:1;
unsigned as_allow:1;
unsigned as_nextnonce:1;
unsigned :0;
msg_header_t *as_response;
msg_header_t *as_info;
msg_header_t *as_match;
auth_magic_t *as_magic;
auth_callback_t*as_callback;
auth_splugin_t *as_plugin;
};
typedef struct auth_challenger
{
int ach_status;
char const *ach_phrase;
msg_hclass_t *ach_header;
msg_hclass_t *ach_info;
} auth_challenger_t;
SOFIAPUBVAR char const auth_internal_server_error[];
#define AUTH_STATUS_INIT \
{{ SU_HOME_INIT(auth_status_t) }, 500, auth_internal_server_error, NULL }
#define AUTH_STATUS_DEINIT(as) \
su_home_deinit(as->as_home)
#define AUTH_RESPONSE_INIT(as) AUTH_STATUS_INIT
#define AUTH_RESPONSE_DEINIT(as) AUTH_STATUS_DEINIT(as)
SOFIAPUBFUN int auth_mod_register_plugin(auth_scheme_t *asch);
SOFIAPUBFUN auth_mod_t *auth_mod_create(su_root_t *root,
tag_type_t, tag_value_t, ...);
SOFIAPUBFUN void auth_mod_destroy(auth_mod_t *);
SOFIAPUBFUN auth_mod_t *auth_mod_ref(auth_mod_t *am);
SOFIAPUBFUN void auth_mod_unref(auth_mod_t *am);
SOFIAPUBFUN char const *auth_mod_name(auth_mod_t *am);
SOFIAPUBFUN auth_status_t *auth_status_init(void *, isize_t size);
SOFIAPUBFUN auth_status_t *auth_status_init_with(void *, isize_t size,
int status,
char const *phrase);
SOFIAPUBFUN auth_status_t *auth_status_new(su_home_t *);
SOFIAPUBFUN auth_status_t *auth_status_ref(auth_status_t *as);
SOFIAPUBFUN void auth_status_unref(auth_status_t *as);
SOFIAPUBFUN void auth_mod_verify(auth_mod_t *am,
auth_status_t *as,
msg_auth_t *credentials,
auth_challenger_t const *ach);
SOFIAPUBFUN void auth_mod_challenge(auth_mod_t *am,
auth_status_t *as,
auth_challenger_t const *ach);
SOFIAPUBFUN void auth_mod_authorize(auth_mod_t *am,
auth_status_t *as,
auth_challenger_t const *ach);
SOFIAPUBFUN void auth_mod_cancel(auth_mod_t *am, auth_status_t *as);
/* ====================================================================== */
/* Deprecated functions */
typedef enum {
auth_server,
auth_proxy,
auth_proxy_consume,
auth_consume
} auth_kind_t;
SOFIAPUBFUN void auth_mod_method(auth_mod_t *am,
auth_status_t *as,
msg_auth_t *credentials,
auth_challenger_t const *ach);
SOFIAPUBFUN void auth_mod_check_client(auth_mod_t *am,
auth_status_t *as,
msg_auth_t *credentials,
auth_challenger_t const *ach);
SOFIAPUBFUN void auth_mod_challenge_client(auth_mod_t *am,
auth_status_t *as,
auth_challenger_t const *ach);
#ifdef SIP_H
SOFIAPUBFUN void auth_mod_check(auth_mod_t *am,
auth_status_t *as,
sip_t const *sip,
auth_kind_t proxy);
#endif
#ifdef HTTP_H
SOFIAPUBFUN const char *auth_mod_check_http(auth_mod_t *am,
auth_status_t *as,
http_t const *http,
auth_kind_t proxy);
#endif
/* ====================================================================== */
/* Tags */
#define AUTHTAG_ANY() authtag_any, ((tag_value_t)0)
SOFIAPUBVAR tag_typedef_t authtag_any;
#define AUTHTAG_MODULE(x) authtag_module, authtag_module_v((x))
SOFIAPUBVAR tag_typedef_t authtag_module;
#define AUTHTAG_MODULE_REF(x) authtag_module_ref, authtag_module_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_module_ref;
#if SU_INLINE_TAG_CAST
su_inline tag_value_t authtag_module_v(auth_mod_t *v) {
return (tag_value_t)v;
}
su_inline tag_value_t authtag_module_vr(auth_mod_t **vp) {
return (tag_value_t)vp;
}
#else
#define authtag_module_v(v) ((tag_value_t)(v))
#define authtag_module_vr(v) ((tag_value_t)(v))
#endif
#define AUTHTAG_METHOD(x) authtag_method, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_method;
#define AUTHTAG_METHOD_REF(x) authtag_method_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_method_ref;
#define AUTHTAG_REALM(x) authtag_realm, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_realm;
#define AUTHTAG_REALM_REF(x) authtag_realm_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_realm_ref;
#define AUTHTAG_OPAQUE(x) authtag_opaque, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_opaque;
#define AUTHTAG_OPAQUE_REF(x) authtag_opaque_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_opaque_ref;
#define AUTHTAG_DB(x) authtag_db, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_db;
#define AUTHTAG_DB_REF(x) authtag_db_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_db_ref;
#define AUTHTAG_QOP(x) authtag_qop, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_qop;
#define AUTHTAG_QOP_REF(x) authtag_qop_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_qop_ref;
#define AUTHTAG_ALGORITHM(x) authtag_algorithm, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_algorithm;
#define AUTHTAG_ALGORITHM_REF(x) authtag_algorithm_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_algorithm_ref;
#define AUTHTAG_EXPIRES(x) authtag_expires, tag_uint_v((x))
SOFIAPUBVAR tag_typedef_t authtag_expires;
#define AUTHTAG_EXPIRES_REF(x) authtag_expires_ref, tag_uint_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_expires_ref;
#define AUTHTAG_NEXT_EXPIRES(x) authtag_next_expires, tag_uint_v((x))
SOFIAPUBVAR tag_typedef_t authtag_next_expires;
#define AUTHTAG_NEXT_EXPIRES_REF(x) \
authtag_next_expires_ref, tag_uint_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_next_expires_ref;
#define AUTHTAG_MAX_NCOUNT(x) authtag_max_ncount, tag_uint_v((x))
SOFIAPUBVAR tag_typedef_t authtag_max_ncount;
#define AUTHTAG_MAX_NCOUNT_REF(x) authtag_max_ncount_ref, tag_uint_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_max_ncount_ref;
#define AUTHTAG_BLACKLIST(x) authtag_blacklist, tag_uint_v((x))
SOFIAPUBVAR tag_typedef_t authtag_blacklist;
#define AUTHTAG_BLACKLIST_REF(x) authtag_blacklist_ref, tag_uint_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_blacklist_ref;
#define AUTHTAG_FORBIDDEN(x) authtag_forbidden, tag_bool_v((x))
SOFIAPUBVAR tag_typedef_t authtag_forbidden;
#define AUTHTAG_FORBIDDEN_REF(x) authtag_forbidden_ref, tag_bool_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_forbidden_ref;
#define AUTHTAG_ANONYMOUS(x) authtag_anonymous, tag_bool_v((x))
SOFIAPUBVAR tag_typedef_t authtag_anonymous;
#define AUTHTAG_ANONYMOUS_REF(x) authtag_anonymous_ref, tag_bool_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_anonymous_ref;
#define AUTHTAG_HSS(x) authtag_hss, tag_ptr_v((x))
SOFIAPUBVAR tag_typedef_t authtag_hss;
#define AUTHTAG_HSS_REF(x) authtag_hss_ref, tag_ptr_vr((&x), (x))
SOFIAPUBVAR tag_typedef_t authtag_hss_ref;
#define AUTHTAG_REMOTE(x) authtag_remote, urltag_url_v((x))
SOFIAPUBVAR tag_typedef_t authtag_remote;
#define AUTHTAG_REMOTE_REF(x) authtag_remote_ref, urltag_url_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_remote_ref;
#define AUTHTAG_ALLOW(x) authtag_allow, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_allow;
#define AUTHTAG_ALLOW_REF(x) authtag_allow_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_allow_ref;
#define AUTHTAG_FAKE(x) authtag_fake, tag_bool_v((x))
SOFIAPUBVAR tag_typedef_t authtag_fake;
#define AUTHTAG_FAKE_REF(x) authtag_fake_ref, tag_bool_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_fake_ref;
#define AUTHTAG_MASTER_KEY(x) authtag_master_key, tag_str_v((x))
SOFIAPUBVAR tag_typedef_t authtag_master_key;
#define AUTHTAG_MASTER_KEY_REF(x) authtag_master_key_ref, tag_str_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_master_key_ref;
#define AUTHTAG_CACHE_USERS(x) authtag_cache_users, tag_uint_v((x))
SOFIAPUBVAR tag_typedef_t authtag_cache_users;
#define AUTHTAG_CACHE_USERS_REF(x) authtag_cache_users_ref, tag_uint_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_cache_users_ref;
#define AUTHTAG_CACHE_ERRORS(x) authtag_cache_errors, tag_uint_v((x))
SOFIAPUBVAR tag_typedef_t authtag_cache_errors;
#define AUTHTAG_CACHE_ERRORS_REF(x) authtag_cache_errors_ref, tag_uint_vr((&x))
SOFIAPUBVAR tag_typedef_t authtag_cache_errors_ref;
SOFIA_END_DECLS
#endif
auth_mod_register_plugin
int auth_mod_register_plugin(auth_scheme_t *asch)
Register an authentication plugin.
Definition auth_plugin.c:78
auth_challenger_t
struct auth_challenger auth_challenger_t
Authentication challenge.
auth_mod_unref
void auth_mod_unref(auth_mod_t *am)
Destroy a reference to an authentication module.
Definition auth_module.c:280
auth_mod_destroy
void auth_mod_destroy(auth_mod_t *)
Destroy (a reference to) an authentication module.
Definition auth_module.c:252
auth_mod_verify
void auth_mod_verify(auth_mod_t *am, auth_status_t *as, msg_auth_t *credentials, auth_challenger_t const *ach)
Authenticate user.
Definition auth_module.c:397
auth_mod_cancel
void auth_mod_cancel(auth_mod_t *am, auth_status_t *as)
Cancel asynchronous authentication.
Definition auth_module.c:464
auth_mod_name
char const * auth_mod_name(auth_mod_t *am)
Get authenticatin module name.
Definition auth_module.c:286
auth_uplugin_t
struct auth_uplugin_t auth_uplugin_t
Opaque authentication operation data used by plugin module.
Definition auth_module.h:73
auth_callback_t
void auth_callback_t(auth_magic_t *, auth_status_t *)
Callback from completeted asynchronous authentication operation.
Definition auth_module.h:76
auth_mod_challenge
void auth_mod_challenge(auth_mod_t *am, auth_status_t *as, auth_challenger_t const *ach)
Make a challenge header.
Definition auth_module.c:449
auth_mod_create
auth_mod_t * auth_mod_create(su_root_t *root, tag_type_t, tag_value_t,...)
Create an authentication plugin module.
Definition auth_plugin.c:106
auth_mod_ref
auth_mod_t * auth_mod_ref(auth_mod_t *am)
Create a new reference to authentication module.
Definition auth_module.c:274
auth_splugin_t
struct auth_splugin_t auth_splugin_t
Opaque user data used by plugin module.
Definition auth_module.h:71
auth_scheme_t
struct auth_scheme const auth_scheme_t
Virtual table for authentication plugin.
Definition auth_module.h:66
auth_status_t::as_callback
auth_callback_t * as_callback
Completion callback [in].
Definition auth_module.h:135
auth_status_t::as_magic
auth_magic_t * as_magic
Application data [in].
Definition auth_module.h:134
http_t
struct http_s http_t
msg_time_t
unsigned long msg_time_t
msg_types.h
msg_hclass_t
struct msg_hclass_s const msg_hclass_t
msg_header_t
MSG_HDR_T msg_header_t
sip_t
struct sip_s sip_t
auth_challenger
Authentication challenge.
Definition auth_module.h:150
auth_challenger::ach_phrase
char const * ach_phrase
Response phrase for challenge response.
Definition auth_module.h:152
auth_challenger::ach_status
int ach_status
Response status for challenge response.
Definition auth_module.h:151
auth_challenger::ach_header
msg_hclass_t * ach_header
Header class for challenge header.
Definition auth_module.h:153
auth_mod_t
Common data for authentication module.
Definition auth_plugin.h:125
auth_scheme
Authentication scheme.
Definition auth_plugin.h:66
auth_status_t
Authentication operation result.
Definition auth_module.h:97
auth_status_t::as_anonymous
unsigned as_anonymous
Return true if user is anonymous [out].
Definition auth_module.h:122
auth_status_t::as_home
su_home_t as_home[1]
Memory home for authentication.
Definition auth_module.h:98
auth_status_t::as_plugin
auth_splugin_t * as_plugin
Pointer to extended state, used exclusively by plugin modules.
Definition auth_module.h:139
auth_status_t::as_domain
char const * as_domain
Hostname [in].
Definition auth_module.h:112
auth_status_t::as_display
char const * as_display
Return user's real name [in/out].
Definition auth_module.h:103
auth_status_t::as_nonce_issued
msg_time_t as_nonce_issued
Nonce issue time [out].
Definition auth_module.h:120
auth_status_t::as_blacklist
unsigned as_blacklist
Blacklist time [out].
Definition auth_module.h:121
auth_status_t::as_ident
char const * as_ident
Identities [out].
Definition auth_module.h:106
auth_status_t::as_match
msg_header_t * as_match
Used authentication header [out].
Definition auth_module.h:130
auth_status_t::as_profile
unsigned as_profile
User profile (group) [out].
Definition auth_module.h:107
auth_status_t::as_bodylen
isize_t as_bodylen
Length of message body [in].
Definition auth_module.h:118
auth_status_t::as_method
char const * as_method
Method name to authenticate [in].
Definition auth_module.h:115
auth_status_t::as_uri
char const * as_uri
Request-URI [in].
Definition auth_module.h:113
auth_status_t::as_realm
char const * as_realm
Authentication realm [in].
Definition auth_module.h:111
auth_status_t::as_phrase
char const * as_phrase
Return response phrase [out].
Definition auth_module.h:101
auth_status_t::as_body
void const * as_body
Message body to protect [in].
Definition auth_module.h:117
auth_status_t::as_status
int as_status
Return authorization status [out].
Definition auth_module.h:100
auth_status_t::as_pdomain
char const * as_pdomain
Domain parameter [in] (ignored).
Definition auth_module.h:114
auth_status_t::as_info
msg_header_t * as_info
Authentication-Info [out].
Definition auth_module.h:129
auth_status_t::as_source
su_addrinfo_t * as_source
Source address [in].
Definition auth_module.h:109
auth_status_t::as_allow
unsigned as_allow
Method cannot be challenged [out].
Definition auth_module.h:124
auth_status_t::as_nextnonce
unsigned as_nextnonce
Client used nextnonce [out].
Definition auth_module.h:125
auth_status_t::as_user
char const * as_user
Authenticated username [in/out].
Definition auth_module.h:102
auth_status_t::as_stale
unsigned as_stale
Credentials were stale [out].
Definition auth_module.h:123
auth_status_t::as_response
msg_header_t * as_response
Authentication challenge [out].
Definition auth_module.h:128
url_t
su_addrinfo_t
struct addrinfo su_addrinfo_t
su_home_t
SU_HOME_T su_home_t
SOFIAPUBFUN
#define SOFIAPUBFUN
SOFIAPUBVAR
#define SOFIAPUBVAR
su_inline
#define su_inline
su_tag.h
tag_typedef_t
struct tag_type_s const tag_typedef_t[1]
tag_value_t
intptr_t tag_value_t
tag_type_t
struct tag_type_s const * tag_type_t
su_wait.h
su_root_t
struct su_root_t su_root_t
url.h

Sofia-SIP 1.12.11devel - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.