git migration: Refactor the ASTERISK_FILE_VERSION macro
[asterisk/asterisk.git] / funcs / func_sha1.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  * Copyright (C) 2006, Claude Patry
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  *
20  * \brief SHA1 digest related dialplan functions
21  * 
22  * \author Claude Patry <cpatry@gmail.com>
23  *
24  * \ingroup functions
25  */
26
27 /*** MODULEINFO
28         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_REGISTER_FILE()
34
35 #include "asterisk/module.h"
36 #include "asterisk/pbx.h"
37
38 /*** DOCUMENTATION
39         <function name="SHA1" language="en_US">
40                 <synopsis>
41                         Computes a SHA1 digest.
42                 </synopsis>
43                 <syntax>
44                         <parameter name="data" required="true">
45                                 <para>Input string</para>
46                         </parameter>
47                 </syntax>
48                 <description>
49                         <para>Generate a SHA1 digest via the SHA1 algorythm.</para>
50                         <para>Example:  Set(sha1hash=${SHA1(junky)})</para>
51                         <para>Sets the asterisk variable sha1hash to the string <literal>60fa5675b9303eb62f99a9cd47f9f5837d18f9a0</literal>
52                         which is known as his hash</para>       
53                 </description>
54         </function>
55  ***/
56
57 static int sha1(struct ast_channel *chan, const char *cmd, char *data,
58                 char *buf, size_t len)
59 {
60         *buf = '\0';
61
62         if (ast_strlen_zero(data)) {
63                 ast_log(LOG_WARNING, "Syntax: SHA1(<data>) - missing argument!\n");
64                 return -1;
65         }
66
67         if (len >= 41)
68                 ast_sha1_hash(buf, data);
69         else {
70                 ast_log(LOG_ERROR,
71                                 "Insufficient space to produce SHA1 hash result (%d < 41)\n",
72                                 (int) len);
73         }
74
75         return 0;
76 }
77
78 static struct ast_custom_function sha1_function = {
79         .name = "SHA1",
80         .read = sha1,
81         .read_max = 42,
82 };
83
84 static int unload_module(void)
85 {
86         return ast_custom_function_unregister(&sha1_function);
87 }
88
89 static int load_module(void)
90 {
91         return ast_custom_function_register(&sha1_function);
92 }
93
94 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "SHA-1 computation dialplan function");