2 * Main libfaim header. Must be included in client for prototypes/macros.
9 #include <faim/faimconfig.h>
10 #include <faim/aim_cbtypes.h>
15 #include <sys/types.h>
26 #include <sys/socket.h>
27 #include <netinet/in.h>
32 /* Portability stuff (DMP) */
36 #define strlen(x) (int)strlen(x) /* win32 has a unsigned size_t */
39 #if defined(_WIN32) || (defined(mach) && defined(__APPLE__))
40 #define gethostbyname2(x,y) gethostbyname(x) /* revert to IPv4 */
44 * Current Maximum Length for Screen Names (not including NULL)
49 * Standard size of an AIM authorization cookie
51 #define AIM_COOKIELEN 0x100
54 #define faimdprintf(l, x...) {if (l >= debug) printf(x); }
56 #define faimdprintf(l, x...)
60 * Login info. Passes information from the Authorization
61 * stage of login to the service (BOS, etc) connection
65 struct aim_login_struct {
66 char screen_name[MAXSNLEN+1];
68 char cookie[AIM_COOKIELEN];
76 * Client info. Filled in by the client and passed
77 * in to aim_login(). The information ends up
78 * getting passed to OSCAR through the initial
81 * XXX: Should this be per-session? -mid
84 struct client_info_s {
85 char clientstring[100]; /* arbitrary size */
99 * These could be arbitrary, but its easier to use the actual AIM values
101 #define AIM_CONN_TYPE_AUTH 0x0007
102 #define AIM_CONN_TYPE_ADS 0x0005
103 #define AIM_CONN_TYPE_BOS 0x0002
104 #define AIM_CONN_TYPE_CHAT 0x000e
105 #define AIM_CONN_TYPE_CHATNAV 0x000d
108 * Status values returned from aim_conn_new(). ORed together.
110 #define AIM_CONN_STATUS_READY 0x0001
111 #define AIM_CONN_STATUS_INTERNALERR 0x0002
112 #define AIM_CONN_STATUS_RESOLVERR 0x0080
113 #define AIM_CONN_STATUS_CONNERR 0x0040
120 void *priv; /* misc data the client may want to store */
121 time_t lastactivity; /* time of last transmit */
123 struct aim_rxcblist_t *handlerlist;
126 /* struct for incoming commands */
127 struct command_rx_struct {
128 /* byte 1 assumed to always be 0x2a */
129 char type; /* type code (byte 2) */
130 u_int seqnum; /* sequence number (bytes 3 and 4) */
131 u_int commandlen; /* total packet len - 6 (bytes 5 and 6) */
132 u_char *data; /* packet data (from 7 byte on) */
133 u_int lock; /* 0 = open, !0 = locked */
134 u_int handled; /* 0 = new, !0 = been handled */
135 u_int nofree; /* 0 = free data on purge, 1 = only unlink */
136 struct aim_conn_t *conn; /* the connection it came in on... */
137 struct command_rx_struct *next; /* ptr to next struct in list */
140 /* struct for outgoing commands */
141 struct command_tx_struct {
142 /* byte 1 assumed to be 0x2a */
143 char type; /* type/family code */
144 u_int seqnum; /* seqnum dynamically assigned on tx */
145 u_int commandlen; /* SNAC length */
146 u_char *data; /* packet data */
147 u_int lock; /* 0 = open, !0 = locked */
148 u_int sent; /* 0 = pending, !0 = has been sent */
149 struct aim_conn_t *conn;
150 struct command_tx_struct *next; /* ptr to next struct in list */
155 * AIM Session: The main client-data interface.
158 struct aim_session_t {
160 /* ---- Client Accessible ------------------------ */
162 * Login information. See definition above.
165 struct aim_login_struct logininfo;
168 * Pointer to anything the client wants to
169 * explicitly associate with this session.
174 /* ---- Internal Use Only ------------------------ */
176 * Connection information
178 struct aim_conn_t conns[AIM_CONN_MAX];
183 struct command_tx_struct *queue_outgoing;
184 struct command_rx_struct *queue_incoming;
187 * This is a dreadful solution to the what-room-are-we-joining
188 * problem. (There's no connection between the service
189 * request and the resulting redirect.)
194 * Outstanding snac handling
196 * XXX: Should these be per-connection? -mid
198 struct aim_snac_t *outstanding_snacs;
204 * AIM User Info, Standard Form.
206 struct aim_userinfo_s {
216 #define AIM_CLASS_TRIAL 0x0001
217 #define AIM_CLASS_UNKNOWN2 0x0002
218 #define AIM_CLASS_AOL 0x0004
219 #define AIM_CLASS_UNKNOWN4 0x0008
220 #define AIM_CLASS_FREE 0x0010
221 #define AIM_CLASS_AWAY 0x0020
222 #define AIM_CLASS_UNKNOWN40 0x0040
223 #define AIM_CLASS_UNKNOWN80 0x0080
229 /* Generic TLV structure. */
237 struct aim_tlvlist_t {
238 struct aim_tlv_t *tlv;
239 struct aim_tlvlist_t *next;
242 /* TLV-handling functions */
243 struct aim_tlvlist_t *aim_readtlvchain(u_char *buf, int maxlen);
244 void aim_freetlvchain(struct aim_tlvlist_t **list);
245 struct aim_tlv_t *aim_grabtlv(u_char *src);
246 struct aim_tlv_t *aim_grabtlvstr(u_char *src);
247 struct aim_tlv_t *aim_gettlv(struct aim_tlvlist_t *, u_short, int);
248 char *aim_gettlv_str(struct aim_tlvlist_t *, u_short, int);
249 int aim_puttlv (u_char *dest, struct aim_tlv_t *newtlv);
250 struct aim_tlv_t *aim_createtlv(void);
251 int aim_freetlv(struct aim_tlv_t **oldtlv);
252 int aim_puttlv_16(u_char *, u_short, u_short);
253 int aim_puttlv_32(u_char *, u_short, u_long);
254 int aim_puttlv_str(u_char *buf, u_short t, u_short l, u_char *v);
255 int aim_writetlvchain(u_char *buf, int buflen, struct aim_tlvlist_t **list);
256 int aim_addtlvtochain16(struct aim_tlvlist_t **list, unsigned short type, unsigned short val);
257 int aim_addtlvtochain32(struct aim_tlvlist_t **list, unsigned short type, unsigned long val);
258 int aim_addtlvtochain_str(struct aim_tlvlist_t **list, unsigned short type, char *str, int len);
259 int aim_counttlvchain(struct aim_tlvlist_t **list);
262 * Get command from connections / Dispatch commands
265 int aim_get_command(struct aim_session_t *);
266 int aim_rxdispatch(struct aim_session_t *);
268 int aim_logoff(struct aim_session_t *);
271 typedef int (*rxcallback_t)(struct aim_session_t *, struct command_rx_struct *, ...);
272 int aim_register_callbacks(rxcallback_t *);
274 u_long aim_genericreq_n(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype);
275 u_long aim_genericreq_l(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_long *);
276 u_long aim_genericreq_s(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_short *);
279 int aim_sendconnack(struct aim_session_t *sess, struct aim_conn_t *conn);
280 int aim_request_login (struct aim_session_t *sess, struct aim_conn_t *conn, char *sn);
281 int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *);
282 int aim_encode_password(const char *, u_char *);
283 unsigned long aim_sendauthresp(struct aim_session_t *sess,
284 struct aim_conn_t *conn,
285 char *sn, char *bosip,
286 char *cookie, char *email,
288 int aim_gencookie(unsigned char *buf);
289 int aim_sendserverready(struct aim_session_t *sess, struct aim_conn_t *conn);
290 unsigned long aim_sendredirect(struct aim_session_t *sess,
291 struct aim_conn_t *conn,
292 unsigned short servid,
295 void aim_purge_rxqueue(struct aim_session_t *);
298 int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *command, ...);
299 int aim_parse_missed_im(struct aim_session_t *, struct command_rx_struct *, ...);
300 int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);
302 int aim_tx_enqueue(struct aim_session_t *, struct command_tx_struct *);
303 u_int aim_get_next_txseqnum(struct aim_conn_t *);
304 int aim_tx_flushqueue(struct aim_session_t *);
305 int aim_tx_printqueue(struct aim_session_t *);
306 void aim_tx_purgequeue(struct aim_session_t *);
308 struct aim_rxcblist_t {
311 rxcallback_t handler;
313 struct aim_rxcblist_t *next;
316 int aim_conn_setlatency(struct aim_conn_t *conn, int newval);
318 int aim_conn_addhandler(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short type, rxcallback_t newhandler, u_short flags);
319 rxcallback_t aim_callhandler(struct aim_conn_t *conn, u_short family, u_short type);
320 int aim_clearhandlers(struct aim_conn_t *conn);
323 * Generic SNAC structure. Rarely if ever used.
332 struct aim_snac_t *next;
334 u_long aim_newsnac(struct aim_session_t *, struct aim_snac_t *newsnac);
335 struct aim_snac_t *aim_remsnac(struct aim_session_t *, u_long id);
336 int aim_cleansnacs(struct aim_session_t *, int maxage);
337 int aim_putsnac(u_char *, int, int, int, u_long);
340 void aim_connrst(struct aim_session_t *);
341 struct aim_conn_t *aim_conn_getnext(struct aim_session_t *);
342 void aim_conn_close(struct aim_conn_t *deadconn);
343 struct aim_conn_t *aim_getconn_type(struct aim_session_t *, int type);
344 struct aim_conn_t *aim_newconn(struct aim_session_t *, int type, char *dest);
345 int aim_conngetmaxfd(struct aim_session_t *);
346 struct aim_conn_t *aim_select(struct aim_session_t *, struct timeval *, int *);
347 int aim_conn_isready(struct aim_conn_t *);
348 int aim_conn_setstatus(struct aim_conn_t *, int);
349 void aim_session_init(struct aim_session_t *);
353 #define AIM_VISIBILITYCHANGE_PERMITADD 0x05
354 #define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
355 #define AIM_VISIBILITYCHANGE_DENYADD 0x07
356 #define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08
358 u_long aim_bos_setidle(struct aim_session_t *, struct aim_conn_t *, u_long);
359 u_long aim_bos_changevisibility(struct aim_session_t *, struct aim_conn_t *, int, char *);
360 u_long aim_bos_setbuddylist(struct aim_session_t *, struct aim_conn_t *, char *);
361 u_long aim_bos_setprofile(struct aim_session_t *, struct aim_conn_t *, char *, char *);
362 u_long aim_bos_setgroupperm(struct aim_session_t *, struct aim_conn_t *, u_long);
363 u_long aim_bos_clientready(struct aim_session_t *, struct aim_conn_t *);
364 u_long aim_bos_reqrate(struct aim_session_t *, struct aim_conn_t *);
365 u_long aim_bos_ackrateresp(struct aim_session_t *, struct aim_conn_t *);
366 u_long aim_bos_setprivacyflags(struct aim_session_t *, struct aim_conn_t *, u_long);
367 u_long aim_bos_reqpersonalinfo(struct aim_session_t *, struct aim_conn_t *);
368 u_long aim_bos_reqservice(struct aim_session_t *, struct aim_conn_t *, u_short);
369 u_long aim_bos_reqrights(struct aim_session_t *, struct aim_conn_t *);
370 u_long aim_bos_reqbuddyrights(struct aim_session_t *, struct aim_conn_t *);
371 u_long aim_bos_reqlocaterights(struct aim_session_t *, struct aim_conn_t *);
372 u_long aim_bos_reqicbmparaminfo(struct aim_session_t *, struct aim_conn_t *);
373 u_long aim_setversions(struct aim_session_t *sess, struct aim_conn_t *conn);
375 /* aim_rxhandlers.c */
376 int aim_rxdispatch(struct aim_session_t *);
377 int aim_authparse(struct aim_session_t *, struct command_rx_struct *);
378 int aim_handleredirect_middle(struct aim_session_t *, struct command_rx_struct *, ...);
379 int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *, ...);
380 int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);
381 int aim_parse_generalerrs(struct aim_session_t *, struct command_rx_struct *command, ...);
382 int aim_parsemotd_middle(struct aim_session_t *sess, struct command_rx_struct *command, ...);
385 #define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */
386 #define AIM_IMFLAGS_ACK 0x02 /* request a receipt notice */
388 u_long aim_send_im(struct aim_session_t *, struct aim_conn_t *, char *, u_int, char *);
389 int aim_parse_incoming_im_middle(struct aim_session_t *, struct command_rx_struct *);
390 u_long aim_seticbmparam(struct aim_session_t *, struct aim_conn_t *conn);
391 int aim_parse_msgerror_middle(struct aim_session_t *, struct command_rx_struct *);
394 u_long aim_getinfo(struct aim_session_t *, struct aim_conn_t *, const char *);
395 int aim_extractuserinfo(u_char *, struct aim_userinfo_s *);
396 int aim_parse_userinfo_middle(struct aim_session_t *, struct command_rx_struct *);
397 int aim_parse_oncoming_middle(struct aim_session_t *, struct command_rx_struct *);
398 int aim_parse_offgoing_middle(struct aim_session_t *, struct command_rx_struct *);
401 int aim_auth_sendcookie(struct aim_session_t *, struct aim_conn_t *, u_char *);
402 u_long aim_auth_clientready(struct aim_session_t *, struct aim_conn_t *);
403 u_long aim_auth_changepasswd(struct aim_session_t *, struct aim_conn_t *, char *, char *);
405 /* aim_buddylist.c */
406 u_long aim_add_buddy(struct aim_session_t *, struct aim_conn_t *, char *);
407 u_long aim_remove_buddy(struct aim_session_t *, struct aim_conn_t *, char *);
410 u_long aim_usersearch_address(struct aim_session_t *, struct aim_conn_t *, char *);
411 /* u_long aim_usersearch_name(struct aim_session_t *, struct aim_conn_t *, char *); */
414 struct aim_chat_roominfo {
419 int aim_chat_readroominfo(u_char *buf, struct aim_chat_roominfo *outinfo);
420 int aim_chat_parse_infoupdate(struct aim_session_t *sess, struct command_rx_struct *command);
421 int aim_chat_parse_joined(struct aim_session_t *sess, struct command_rx_struct *command);
422 int aim_chat_parse_leave(struct aim_session_t *sess, struct command_rx_struct *command);
423 int aim_chat_parse_incoming(struct aim_session_t *sess, struct command_rx_struct *command);
424 u_long aim_chat_send_im(struct aim_session_t *sess, struct aim_conn_t *conn, char *msg);
425 u_long aim_chat_join(struct aim_session_t *sess, struct aim_conn_t *conn, u_short exchange, const char *roomname);
426 u_long aim_chat_clientready(struct aim_session_t *sess, struct aim_conn_t *conn);
427 int aim_chat_attachname(struct aim_conn_t *conn, char *roomname);
428 char *aim_chat_getname(struct aim_conn_t *conn);
429 struct aim_conn_t *aim_chat_getconn(struct aim_session_t *, char *name);
431 u_long aim_chatnav_reqrights(struct aim_session_t *sess, struct aim_conn_t *conn);
432 u_long aim_chatnav_clientready(struct aim_session_t *sess, struct aim_conn_t *conn);
434 u_long aim_chat_invite(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn, char *msg, u_short exchange, char *roomname, u_short instance);
436 struct aim_chat_exchangeinfo {
444 int aim_chatnav_parse_info(struct aim_session_t *sess, struct command_rx_struct *command);
445 u_long aim_chatnav_createroom(struct aim_session_t *sess, struct aim_conn_t *conn, char *name, u_short exchange);
446 int aim_chat_leaveroom(struct aim_session_t *sess, char *name);
449 int aimutil_put8(u_char *, u_char);
450 u_char aimutil_get8(u_char *buf);
451 int aimutil_put16(u_char *, u_short);
452 u_short aimutil_get16(u_char *);
453 int aimutil_put32(u_char *, u_long);
454 u_long aimutil_get32(u_char *);
455 int aimutil_putstr(u_char *, const u_char *, int);
456 int aimutil_tokslen(char *toSearch, int index, char dl);
457 int aimutil_itemcnt(char *toSearch, char dl);
458 char *aimutil_itemidx(char *toSearch, int index, char dl);
460 int aim_snlen(const char *sn);
461 int aim_sncmp(const char *sn1, const char *sn2);
463 #endif /* __AIM_H__ */