Doxygen update
[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 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <sys/types.h>
35
36 #include "asterisk/module.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/app.h"
42
43 static int sha1(struct ast_channel *chan, const char *cmd, char *data,
44                 char *buf, size_t len)
45 {
46         *buf = '\0';
47
48         if (ast_strlen_zero(data)) {
49                 ast_log(LOG_WARNING, "Syntax: SHA1(<data>) - missing argument!\n");
50                 return -1;
51         }
52
53         if (len >= 41)
54                 ast_sha1_hash(buf, data);
55         else {
56                 ast_log(LOG_ERROR,
57                                 "Insufficient space to produce SHA1 hash result (%d < 41)\n",
58                                 (int) len);
59         }
60
61         return 0;
62 }
63
64 static struct ast_custom_function sha1_function = {
65         .name = "SHA1",
66         .synopsis = "Computes a SHA1 digest",
67         .syntax = "SHA1(<data>)",
68         .read = sha1,
69         .desc = "Generate a SHA1 digest via the SHA1 algorythm.\n"
70                 " Example:  Set(sha1hash=${SHA1(junky)})\n"
71                 " Sets the asterisk variable sha1hash to the string '60fa5675b9303eb62f99a9cd47f9f5837d18f9a0'\n"
72                 " which is known as his hash\n",
73 };
74
75 static int unload_module(void)
76 {
77         return ast_custom_function_unregister(&sha1_function);
78 }
79
80 static int load_module(void)
81 {
82         return ast_custom_function_register(&sha1_function);
83 }
84
85 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "SHA-1 computation dialplan function");