b9d5412b1bd897df54d11181229f3da172518a91
[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 /*! \file
19  *
20  * \brief MD5 checksum application
21  * 
22  * \todo Remove this deprecated application in 1.3dev
23  * \ingroup applications
24  */
25
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <string.h>
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/file.h"
35 #include "asterisk/logger.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/options.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/module.h"
41 #include "asterisk/lock.h"
42 #include "asterisk/app.h"
43
44 static char *tdesc_md5 = "MD5 checksum applications";
45 static char *app_md5 = "MD5";
46 static char *desc_md5 = "Calculate MD5 checksum";
47 static char *synopsis_md5 = 
48 "  MD5(<var>=<string>): Calculates a MD5 checksum on <string>.\n"
49 "Returns hash value in a channel variable. \n";
50
51 static char *app_md5check = "MD5Check";
52 static char *desc_md5check = "Check MD5 checksum";
53 static char *synopsis_md5check = 
54 "  MD5Check(<md5hash>|<string>[|options]): Calculates a MD5 checksum on <string>\n"
55 "and compares it with the hash. Returns 0 if <md5hash> is correct for <string>.\n"
56 "The option string may contain zero or more of the following characters:\n"
57 "       'j' -- jump to priority n+101 if the hash and string do not match \n"
58 "This application sets the following channel variable upon completion:\n"
59 "       CHECKMD5STATUS  The status of the MD5 check, one of the following\n"
60 "               MATCH | NOMATCH\n";
61
62 STANDARD_LOCAL_USER;
63
64 LOCAL_USER_DECL;
65
66 /*--- md5_exec: Calculate MD5 checksum (hash) on given string and
67         return it in channel variable ---*/
68 static int md5_exec(struct ast_channel *chan, void *data)
69 {
70         int res=0;
71         struct localuser *u;
72         char *varname= NULL; /* Variable to set */
73         char *string = NULL; /* String to calculate on */
74         char retvar[50]; /* Return value */
75         static int dep_warning = 0;
76
77         if (!dep_warning) {
78                 ast_log(LOG_WARNING, "This application has been deprecated, please use the MD5 function instead.\n");
79                 dep_warning = 1;
80         }       
81
82         if (ast_strlen_zero(data)) {
83                 ast_log(LOG_WARNING, "Syntax: md5(<varname>=<string>) - missing argument!\n");
84                 return -1;
85         }
86         
87         LOCAL_USER_ADD(u);
88
89         memset(retvar,0, sizeof(retvar));
90         string = ast_strdupa(data);
91         varname = strsep(&string,"=");
92         if (ast_strlen_zero(varname)) {
93                 ast_log(LOG_WARNING, "Syntax: md5(<varname>=<string>) - missing argument!\n");
94                 LOCAL_USER_REMOVE(u);
95                 return -1;
96         }
97         ast_md5_hash(retvar, string);
98         pbx_builtin_setvar_helper(chan, varname, retvar);
99         LOCAL_USER_REMOVE(u);
100         return res;
101 }
102
103 /*--- md5check_exec: Calculate MD5 checksum and compare it with
104         existing checksum. ---*/
105 static int md5check_exec(struct ast_channel *chan, void *data)
106 {
107         int res=0;
108         struct localuser *u;
109         char *string = NULL; /* String to calculate on */
110         char newhash[50]; /* Return value */
111         static int dep_warning = 0;
112         int priority_jump = 0;
113         AST_DECLARE_APP_ARGS(args,
114                 AST_APP_ARG(md5hash);
115                 AST_APP_ARG(string);
116                 AST_APP_ARG(options);
117         );
118
119         if (!dep_warning) {
120                 ast_log(LOG_WARNING, "This application has been deprecated, please use the CHECK_MD5 function instead.\n");
121                 dep_warning = 1;
122         }
123         
124         LOCAL_USER_ADD(u);
125
126         if (!(string = ast_strdupa(data))) {
127                 ast_log(LOG_WARNING, "Memory Error!\n");
128                 LOCAL_USER_REMOVE(u);
129                 return -1;
130         }
131
132         AST_STANDARD_APP_ARGS(args, string);
133
134         if (args.options) {
135                 if (strchr(args.options, 'j'))
136                         priority_jump = 1;
137         }
138
139         if (ast_strlen_zero(args.md5hash) || ast_strlen_zero(args.string)) {
140                 ast_log(LOG_WARNING, "Syntax: MD5Check(<md5hash>|<string>[|options]) - missing argument!\n");
141                 LOCAL_USER_REMOVE(u);
142                 return -1;
143         }
144
145         memset(newhash,0, sizeof(newhash));
146
147         ast_md5_hash(newhash, args.string);
148         if (!strcmp(newhash, args.md5hash)) {   /* Verification ok */
149                 if (option_debug > 2)
150                         ast_log(LOG_DEBUG, "MD5 verified ok: %s -- %s\n", args.md5hash, args.string);
151                 pbx_builtin_setvar_helper(chan, "CHECKMD5STATUS", "MATCH");
152                 LOCAL_USER_REMOVE(u);
153                 return 0;
154         }
155         if (option_debug > 2)
156                 ast_log(LOG_DEBUG, "ERROR: MD5 not verified: %s -- %s\n", args.md5hash, args.string);
157         pbx_builtin_setvar_helper(chan, "CHECKMD5STATUS", "NOMATCH");           
158         if (priority_jump || option_priority_jumping) {
159                 if (!ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101))
160                         if (option_debug > 2)
161                                 ast_log(LOG_DEBUG, "ERROR: Can't jump to exten+101 (e%s,p%d), sorry\n", chan->exten,chan->priority+101);
162         }
163         LOCAL_USER_REMOVE(u);
164         return res;
165 }
166
167 int unload_module(void)
168 {
169         int res;
170
171         res = ast_unregister_application(app_md5);
172         res |= ast_unregister_application(app_md5check);
173
174         STANDARD_HANGUP_LOCALUSERS;
175
176         return res;
177 }
178
179 int load_module(void)
180 {
181         int res;
182
183         res = ast_register_application(app_md5check, md5check_exec, desc_md5check, synopsis_md5check);
184         res |= ast_register_application(app_md5, md5_exec, desc_md5, synopsis_md5);
185         
186         return res;
187 }
188
189 char *description(void)
190 {
191         return tdesc_md5;
192 }
193
194 int usecount(void)
195 {
196         int res;
197         STANDARD_USECOUNT(res);
198         return res;
199 }
200
201 char *key()
202 {
203         return ASTERISK_GPL_KEY;
204 }