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