Add auth_policy option to jabber.conf for auto user registration.
[asterisk/asterisk.git] / include / asterisk / jabber.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Matt O'Gorman <mogorman@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief AJI - The Asterisk Jabber Interface
21  * \arg \ref AJI_intro
22  * \ref res_jabber.c
23  * \author Matt O'Gorman <mogorman@digium.com>
24  * \extref IKSEMEL http://iksemel.jabberstudio.org
25  *
26  * \page AJI_intro AJI - The Asterisk Jabber Interface
27  * 
28  * The Asterisk Jabber Interface, AJI, publishes an API for
29  * modules to use jabber communication. res_jabber.c implements
30  * a Jabber client and a component that can connect as a service
31  * to Jabber servers.
32  *
33  * \section External dependencies
34  * AJI use the IKSEMEL library found at http://iksemel.jabberstudio.org/
35  *
36  * \section Files
37  * - res_jabber.c
38  * - jabber.h
39  * - chan_gtalk.c
40  *
41  */
42
43 #ifndef _ASTERISK_JABBER_H
44 #define _ASTERISK_JABBER_H
45
46 #ifdef HAVE_OPENSSL
47
48 #include <openssl/ssl.h>
49 #include <openssl/err.h>
50 #define TRY_SECURE 2
51 #define SECURE 4
52
53 #endif /* HAVE_OPENSSL */
54 /* file is read by blocks with this size */
55 #define NET_IO_BUF_SIZE 4096
56 /* Return value for timeout connection expiration */
57 #define IKS_NET_EXPIRED 12
58
59 #include <iksemel.h>
60 #include "asterisk/astobj.h"
61 #include "asterisk/linkedlists.h"
62
63 /* 
64  * As per RFC 3920 - section 3.1, the maximum length for a full Jabber ID 
65  * is 3071 bytes.
66  * The ABNF syntax for jid :
67  * jid = [node "@" ] domain [ "/" resource ]
68  * Each allowable portion of a JID (node identifier, domain identifier,
69  * and resource identifier) MUST NOT be more than 1023 bytes in length,
70  * resulting in a maximum total size (including the '@' and '/' separators) 
71  * of 3071 bytes.
72  */
73 #define AJI_MAX_JIDLEN 3071
74 #define AJI_MAX_RESJIDLEN 1023
75
76 #define MUC_NS "http://jabber.org/protocol/muc"
77
78 enum aji_state {
79         AJI_DISCONNECTING,
80         AJI_DISCONNECTED,
81         AJI_CONNECTING,
82         AJI_CONNECTED
83 };
84
85 enum {
86         AJI_AUTOPRUNE = (1 << 0),
87         AJI_AUTOREGISTER = (1 << 1),
88         AJI_AUTOACCEPT = (1 << 2)
89 };
90
91 enum aji_btype {
92         AJI_USER=0,
93         AJI_TRANS=1,
94         AJI_UTRANS=2
95 };
96
97 struct aji_version {
98         char version[50];
99         int jingle;
100         struct aji_capabilities *parent;
101         struct aji_version *next;
102 };
103
104 struct aji_capabilities {
105         char node[200];
106         struct aji_version *versions;
107         struct aji_capabilities *next;
108 };
109
110 struct aji_resource {
111         int status;
112         char resource[AJI_MAX_RESJIDLEN];
113         char *description;
114         struct aji_version *cap;
115         int priority;
116         struct aji_resource *next;
117 };
118
119 struct aji_message {
120         char *from;
121         char *message;
122         char id[25];
123         struct timeval arrived;
124         AST_LIST_ENTRY(aji_message) list;
125 };
126
127 struct aji_buddy {
128         ASTOBJ_COMPONENTS_FULL(struct aji_buddy, AJI_MAX_JIDLEN, 1);
129         char channel[160];
130         struct aji_resource *resources;
131         enum aji_btype btype;
132         struct ast_flags flags;
133 };
134
135 struct aji_buddy_container {
136         ASTOBJ_CONTAINER_COMPONENTS(struct aji_buddy);
137 };
138
139 struct aji_transport_container {
140         ASTOBJ_CONTAINER_COMPONENTS(struct aji_transport);
141 };
142
143 struct aji_client {
144         ASTOBJ_COMPONENTS(struct aji_client);
145         char password[160];
146         char user[AJI_MAX_JIDLEN];
147         char serverhost[AJI_MAX_RESJIDLEN];
148         char statusmessage[256];
149         char name_space[256];
150         char sid[10]; /* Session ID */
151         char mid[6]; /* Message ID */
152         iksid *jid;
153         iksparser *p;
154         iksfilter *f;
155         ikstack *stack;
156 #ifdef HAVE_OPENSSL
157         SSL_CTX *ssl_context;
158         SSL *ssl_session;
159         SSL_METHOD *ssl_method;
160         unsigned int stream_flags;
161 #endif /* HAVE_OPENSSL */
162         enum aji_state state;
163         int port;
164         int debug;
165         int usetls;
166         int forcessl;
167         int usesasl;
168         int keepalive;
169         int allowguest;
170         int timeout;
171         int message_timeout;
172         int authorized;
173         struct ast_flags flags;
174         int component; /* 0 client,  1 component */
175         struct aji_buddy_container buddies;
176         AST_LIST_HEAD(messages,aji_message) messages;
177         void *jingle;
178         pthread_t thread;
179         int priority;
180         enum ikshowtype status;
181 };
182
183 struct aji_client_container{
184         ASTOBJ_CONTAINER_COMPONENTS(struct aji_client);
185 };
186
187 /* !Send XML stanza over the established XMPP connection */
188 int ast_aji_send(struct aji_client *client, iks *x);
189 /*! Send jabber chat message from connected client to jabber URI */
190 int ast_aji_send_chat(struct aji_client *client, const char *address, const char *message);
191 /*! Send jabber chat message from connected client to a groupchat using 
192  *  a given nickname */
193 int ast_aji_send_groupchat(struct aji_client *client, const char *nick, const char *address, const char *message);
194 /*! Disconnect jabber client */
195 int ast_aji_disconnect(struct aji_client *client);
196 int ast_aji_check_roster(void);
197 void ast_aji_increment_mid(char *mid);
198 /*! Open Chat session */
199 int ast_aji_create_chat(struct aji_client *client,char *room, char *server, char *topic);
200 /*! Invite to opened Chat session */
201 int ast_aji_invite_chat(struct aji_client *client, char *user, char *room, char *message);
202 /*! Join/leave existing Chat session */
203 int ast_aji_join_chat(struct aji_client *client, char *room, char *nick);
204 int ast_aji_leave_chat(struct aji_client *client, char *room, char *nick);
205 struct aji_client *ast_aji_get_client(const char *name);
206 struct aji_client_container *ast_aji_get_clients(void);
207
208 #endif