Massive cleanups to applications for LOCAL_USER handling and some other things.
[asterisk/asterisk.git] / apps / app_md5.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005, Olle E. Johansson, Edvina.net
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17
18 /*
19  *
20  * MD5 checksum application
21  * 
22  */
23
24 #include <stdlib.h>
25 #include <unistd.h>
26 #include <string.h>
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/file.h"
33 #include "asterisk/logger.h"
34 #include "asterisk/utils.h"
35 #include "asterisk/options.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/lock.h"
40
41 static char *tdesc_md5 = "MD5 checksum applications";
42 static char *app_md5 = "MD5";
43 static char *desc_md5 = "Calculate MD5 checksum";
44 static char *synopsis_md5 = 
45 "  MD5(<var>=<string>): Calculates a MD5 checksum on <string>.\n"
46 "Returns hash value in a channel variable. Always return 0\n";
47
48 static char *app_md5check = "MD5Check";
49 static char *desc_md5check = "Check MD5 checksum";
50 static char *synopsis_md5check = 
51 "  MD5Check(<md5hash>,<string>): Calculates a MD5 checksum on <string>\n"
52 "and compares it with the hash. Returns 0 if <md5hash> is correct for <string>.\n"
53 "Jumps to priority+101 if incorrect.\n";
54
55 STANDARD_LOCAL_USER;
56
57 LOCAL_USER_DECL;
58
59 /*--- md5_exec: Calculate MD5 checksum (hash) on given string and
60         return it in channel variable ---*/
61 static int md5_exec(struct ast_channel *chan, void *data)
62 {
63         int res=0;
64         struct localuser *u;
65         char *varname= NULL; /* Variable to set */
66         char *string = NULL; /* String to calculate on */
67         char retvar[50]; /* Return value */
68         static int dep_warning = 0;
69
70         if (!dep_warning) {
71                 ast_log(LOG_WARNING, "This application has been deprecated, please use the MD5 function instead.\n");
72                 dep_warning = 1;
73         }       
74
75         if (!data || ast_strlen_zero(data)) {
76                 ast_log(LOG_WARNING, "Syntax: md5(<varname>=<string>) - missing argument!\n");
77                 return -1;
78         }
79         
80         LOCAL_USER_ADD(u);
81
82         memset(retvar,0, sizeof(retvar));
83         string = ast_strdupa(data);
84         varname = strsep(&string,"=");
85         if (ast_strlen_zero(varname)) {
86                 ast_log(LOG_WARNING, "Syntax: md5(<varname>=<string>) - missing argument!\n");
87                 LOCAL_USER_REMOVE(u);
88                 return -1;
89         }
90         ast_md5_hash(retvar, string);
91         pbx_builtin_setvar_helper(chan, varname, retvar);
92         LOCAL_USER_REMOVE(u);
93         return res;
94 }
95
96 /*--- md5check_exec: Calculate MD5 checksum and compare it with
97         existing checksum. ---*/
98 static int md5check_exec(struct ast_channel *chan, void *data)
99 {
100         int res=0;
101         struct localuser *u;
102         char *hash= NULL; /* Hash to compare with */
103         char *string = NULL; /* String to calculate on */
104         char newhash[50]; /* Return value */
105         static int dep_warning = 0;
106
107         if (!dep_warning) {
108                 ast_log(LOG_WARNING, "This application has been deprecated, please use the CHECK_MD5 function instead.\n");
109                 dep_warning = 1;
110         }
111         
112         if (!data || ast_strlen_zero(data)) {
113                 ast_log(LOG_WARNING, "Syntax: MD5Check(<md5hash>,<string>) - missing argument!\n");
114                 return -1;
115         }
116         
117         LOCAL_USER_ADD(u);
118         
119         memset(newhash,0, sizeof(newhash));
120
121         string = ast_strdupa(data);
122         hash = strsep(&string,"|");
123         if (ast_strlen_zero(hash)) {
124                 ast_log(LOG_WARNING, "Syntax: MD5Check(<md5hash>,<string>) - missing argument!\n");
125                 LOCAL_USER_REMOVE(u);
126                 return -1;
127         }
128         ast_md5_hash(newhash, string);
129         if (!strcmp(newhash, hash)) {   /* Verification ok */
130                 if (option_debug > 2)
131                         ast_log(LOG_DEBUG, "MD5 verified ok: %s -- %s\n", hash, string);
132                 LOCAL_USER_REMOVE(u);
133                 return 0;
134         }
135         if (option_debug > 2)
136                 ast_log(LOG_DEBUG, "ERROR: MD5 not verified: %s -- %s\n", hash, string);
137         if (!ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101))
138                 if (option_debug > 2)
139                         ast_log(LOG_DEBUG, "ERROR: Can't jump to exten+101 (e%s,p%d), sorry\n", chan->exten,chan->priority+101);
140         LOCAL_USER_REMOVE(u);
141         return res;
142 }
143
144 int unload_module(void)
145 {
146         int res;
147
148         res = ast_unregister_application(app_md5);
149         res |= ast_unregister_application(app_md5check);
150
151         STANDARD_HANGUP_LOCALUSERS;
152
153         return res;
154 }
155
156 int load_module(void)
157 {
158         int res;
159
160         res = ast_register_application(app_md5check, md5check_exec, desc_md5check, synopsis_md5check);
161         res |= ast_register_application(app_md5, md5_exec, desc_md5, synopsis_md5);
162         
163         return res;
164 }
165
166 char *description(void)
167 {
168         return tdesc_md5;
169 }
170
171 int usecount(void)
172 {
173         int res;
174         STANDARD_USECOUNT(res);
175         return res;
176 }
177
178 char *key()
179 {
180         return ASTERISK_GPL_KEY;
181 }