1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
/*
* $Id: api.h,v 1.2 2005/06/16 12:41:50 bogdan_iancu Exp $
*
* Digest Authentication Module
*
* Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of openser, a free SIP server.
*
* openser 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
*
* openser 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 AUTH_API_H
#define AUTH_API_H
#include "../../parser/msg_parser.h"
#include "../../parser/hf.h"
#include "../../str.h"
#include "../../usr_avp.h"
typedef enum auth_result {
ERROR = -2 , /* Error occurred, a reply has been sent out -> return 0 to the ser core */
NOT_AUTHORIZED, /* Don't perform authorization, credentials missing */
DO_AUTHORIZATION, /* Perform digest authorization */
AUTHORIZED /* Authorized by default, no digest authorization necessary */
} auth_result_t;
/*
* Purpose of this function is to find credentials with given realm,
* do sanity check, validate credential correctness and determine if
* we should really authenticate (there must be no authentication for
* ACK and CANCEL
*/
typedef auth_result_t (*pre_auth_t)(struct sip_msg* _m, str* _realm,
hdr_types_t _hftype, struct hdr_field** _h);
auth_result_t pre_auth(struct sip_msg* _m, str* _realm,
hdr_types_t _hftype, struct hdr_field** _h);
/*
* Purpose of this function is to do post authentication steps like
* marking authorized credentials and so on.
*/
typedef auth_result_t (*post_auth_t)(struct sip_msg* _m, struct hdr_field* _h);
auth_result_t post_auth(struct sip_msg* _m, struct hdr_field* _h);
/*
* Strip the beginning of realm
*/
void strip_realm(str *_realm);
/*
* Auth module API
*/
typedef struct auth_api {
int_str rpid_avp; /* Name of AVP containing Remote-Party-ID */
int rpid_avp_type; /* type of the RPID AVP */
pre_auth_t pre_auth; /* The function to be called before auth */
post_auth_t post_auth; /* The function to be called after auth */
} auth_api_t;
typedef int (*bind_auth_t)(auth_api_t* api);
int bind_auth(auth_api_t* api);
#endif /* AUTH_API_H */
|
