From: mid Date: Tue, 28 Dec 1999 00:55:24 +0000 (+0000) Subject: New headers for session stuff. X-Git-Tag: rel_0_99_2~189 X-Git-Url: http://andersk.mit.edu/gitweb/libfaim.git/commitdiff_plain/bd71fa88aafe5184b226f6c2260b21abf5ec0722 New headers for session stuff. --- diff --git a/faim/aim.h b/faim/aim.h new file mode 100644 index 0000000..9c790d5 --- /dev/null +++ b/faim/aim.h @@ -0,0 +1,381 @@ +/* + * Main libfaim header. Must be included in client for prototypes/macros. + * + */ + +#ifndef __AIM_H__ +#define __AIM_H__ + +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#ifdef _WIN32 +#include +#include +#include +#else +#include +#include +#include +#include +#include +#endif + +/* Portability stuff (DMP) */ + +#ifdef _WIN32 +#define sleep Sleep +#define strlen(x) (int)strlen(x) /* win32 has a unsigned size_t */ +#endif + +#if defined(_WIN32) || (defined(mach) && defined(__APPLE__)) +#define gethostbyname2(x,y) gethostbyname(x) /* revert to IPv4 */ +#endif + +/* + * Current Maximum Length for Screen Names (not including NULL) + */ +#define MAXSNLEN 16 + +/* + * Standard size of an AIM authorization cookie + */ +#define AIM_COOKIELEN 0x100 + +/* + * Login info. Passes information from the Authorization + * stage of login to the service (BOS, etc) connection + * phase. + * + */ +struct aim_login_struct { + char screen_name[MAXSNLEN+1]; + char *BOSIP; + char cookie[AIM_COOKIELEN]; + char *email; + u_short regstatus; +}; + +/* + * Client info. Filled in by the client and passed + * in to aim_login(). The information ends up + * getting passed to OSCAR through the initial + * login command. + * + * XXX: Should this be per-session? -mid + * + */ +struct client_info_s { + char clientstring[100]; /* arbitrary size */ + int major; + int minor; + int build; + char country[3]; + char lang[3]; +}; + +#ifndef TRUE +#define TRUE 1 +#define FALSE 0 +#endif + +/* + * These could be arbitrary, but its easier to use the actual AIM values + */ +#define AIM_CONN_TYPE_AUTH 0x0007 +#define AIM_CONN_TYPE_ADS 0x0005 +#define AIM_CONN_TYPE_BOS 0x0002 +#define AIM_CONN_TYPE_CHAT 0x000e +#define AIM_CONN_TYPE_CHATNAV 0x000d + +/* + * Status values returned from aim_conn_new(). ORed together. + */ +#define AIM_CONN_STATUS_READY 0x0001 +#define AIM_CONN_STATUS_INTERNALERR 0x0002 +#define AIM_CONN_STATUS_RESOLVERR 0x0080 +#define AIM_CONN_STATUS_CONNERR 0x0040 + +struct aim_conn_t { + int fd; + int type; + int seqnum; + int status; + void *priv; /* misc data the client may want to store */ + time_t lastactivity; /* time of last transmit */ + int forcedlatency; + struct aim_rxcblist_t *handlerlist; +}; + +/* struct for incoming commands */ +struct command_rx_struct { + /* byte 1 assumed to always be 0x2a */ + char type; /* type code (byte 2) */ + u_int seqnum; /* sequence number (bytes 3 and 4) */ + u_int commandlen; /* total packet len - 6 (bytes 5 and 6) */ + u_char *data; /* packet data (from 7 byte on) */ + u_int lock; /* 0 = open, !0 = locked */ + u_int handled; /* 0 = new, !0 = been handled */ + struct aim_conn_t *conn; /* the connection it came in on... */ + struct command_rx_struct *next; /* ptr to next struct in list */ +}; + +/* struct for outgoing commands */ +struct command_tx_struct { + /* byte 1 assumed to be 0x2a */ + char type; /* type/family code */ + u_int seqnum; /* seqnum dynamically assigned on tx */ + u_int commandlen; /* SNAC length */ + u_char *data; /* packet data */ + u_int lock; /* 0 = open, !0 = locked */ + u_int sent; /* 0 = pending, !0 = has been sent */ + struct aim_conn_t *conn; + struct command_tx_struct *next; /* ptr to next struct in list */ +}; + + +/* + * AIM Session: The main client-data interface. + * + */ +struct aim_session_t { + + /* ---- Client Accessible ------------------------ */ + /* + * Login information. See definition above. + * + */ + struct aim_login_struct logininfo; + + /* + * Pointer to anything the client wants to + * explicitly associate with this session. + */ + void *aux_data; + + + /* ---- Internal Use Only ------------------------ */ + /* + * Connection information + */ + struct aim_conn_t conns[AIM_CONN_MAX]; + + /* + * TX/RX queues + */ + struct command_tx_struct *queue_outgoing; + struct command_rx_struct *queue_incoming; + + /* + * Outstanding snac handling + * + * XXX: Should these be per-connection? -mid + **/ + struct aim_snac_t *outstanding_snacs; + u_long snac_nextid; +}; + + +/* + * AIM User Info, Standard Form. + */ +struct aim_userinfo_s { + char sn[MAXSNLEN+1]; + u_short warnlevel; + u_short idletime; + u_short class; + u_long membersince; + u_long onlinesince; + u_long sessionlen; +}; + +/* + * TLV handling + */ + +/* Generic TLV structure. */ +struct aim_tlv_t { + u_short type; + u_short length; + u_char *value; +}; + +/* List of above. */ +struct aim_tlvlist_t { + struct aim_tlv_t *tlv; + struct aim_tlvlist_t *next; +}; + +/* TLV-handling functions */ +struct aim_tlvlist_t *aim_readtlvchain(u_char *buf, int maxlen); +void aim_freetlvchain(struct aim_tlvlist_t **list); +struct aim_tlv_t *aim_grabtlv(u_char *src); +struct aim_tlv_t *aim_grabtlvstr(u_char *src); +struct aim_tlv_t *aim_gettlv(struct aim_tlvlist_t *, u_short, int); +char *aim_gettlv_str(struct aim_tlvlist_t *, u_short, int); +int aim_puttlv (u_char *dest, struct aim_tlv_t *newtlv); +struct aim_tlv_t *aim_createtlv(void); +int aim_freetlv(struct aim_tlv_t **oldtlv); +int aim_puttlv_16(u_char *, u_short, u_short); + + +/* + * Get command from connections / Dispatch commands + * already in queue. + */ +int aim_get_command(struct aim_session_t *); +int aim_rxdispatch(struct aim_session_t *); + +int aim_logoff(struct aim_session_t *); + + +typedef int (*rxcallback_t)(struct aim_session_t *, struct command_rx_struct *, ...); +int aim_register_callbacks(rxcallback_t *); + +u_long aim_genericreq_n(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype); +u_long aim_genericreq_l(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_long *); +u_long aim_genericreq_s(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_short *); + +/* aim_login.c */ +int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *); +int aim_encode_password(const char *, u_char *); + + +struct command_rx_struct *aim_purge_rxqueue(struct command_rx_struct *queue); + + +int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *command, ...); +int aim_parse_missed_im(struct aim_session_t *, struct command_rx_struct *, ...); +int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...); + +int aim_tx_enqueue(struct aim_session_t *, struct command_tx_struct *); +u_int aim_get_next_txseqnum(struct aim_conn_t *); +int aim_tx_flushqueue(struct aim_session_t *); +int aim_tx_printqueue(struct aim_session_t *); +int aim_tx_purgequeue(struct aim_session_t *); + +struct aim_rxcblist_t { + u_short family; + u_short type; + rxcallback_t handler; + u_short flags; + struct aim_rxcblist_t *next; +}; + +int aim_conn_setlatency(struct aim_conn_t *conn, int newval); + +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); +rxcallback_t aim_callhandler(struct aim_conn_t *conn, u_short family, u_short type); +int aim_clearhandlers(struct aim_conn_t *conn); + +/* + * Generic SNAC structure. Rarely if ever used. + */ +struct aim_snac_t { + u_long id; + u_short family; + u_short type; + u_short flags; + void *data; + time_t issuetime; + struct aim_snac_t *next; +}; +u_long aim_newsnac(struct aim_session_t *, struct aim_snac_t *newsnac); +struct aim_snac_t *aim_remsnac(struct aim_session_t *, u_long id); +int aim_cleansnacs(struct aim_session_t *, int maxage); +int aim_putsnac(u_char *, int, int, int, u_long); + + +void aim_connrst(struct aim_session_t *); +struct aim_conn_t *aim_conn_getnext(struct aim_session_t *); +void aim_conn_close(struct aim_conn_t *deadconn); +struct aim_conn_t *aim_getconn_type(struct aim_session_t *, int type); +struct aim_conn_t *aim_newconn(struct aim_session_t *, int type, char *dest); +int aim_conngetmaxfd(struct aim_session_t *); +struct aim_conn_t *aim_select(struct aim_session_t *, struct timeval *); +int aim_conn_isready(struct aim_conn_t *); +int aim_conn_setstatus(struct aim_conn_t *, int); +void aim_session_init(struct aim_session_t *); + +/* aim_misc.c */ + +#define AIM_VISIBILITYCHANGE_PERMITADD 0x05 +#define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06 +#define AIM_VISIBILITYCHANGE_DENYADD 0x07 +#define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08 + +u_long aim_bos_setidle(struct aim_session_t *, struct aim_conn_t *, u_long); +u_long aim_bos_changevisibility(struct aim_session_t *, struct aim_conn_t *, int, char *); +u_long aim_bos_setbuddylist(struct aim_session_t *, struct aim_conn_t *, char *); +u_long aim_bos_setprofile(struct aim_session_t *, struct aim_conn_t *, char *); +u_long aim_bos_setgroupperm(struct aim_session_t *, struct aim_conn_t *, u_long); +u_long aim_bos_clientready(struct aim_session_t *, struct aim_conn_t *); +u_long aim_bos_reqrate(struct aim_session_t *, struct aim_conn_t *); +u_long aim_bos_ackrateresp(struct aim_session_t *, struct aim_conn_t *); +u_long aim_bos_setprivacyflags(struct aim_session_t *, struct aim_conn_t *, u_long); +u_long aim_bos_reqpersonalinfo(struct aim_session_t *, struct aim_conn_t *); +u_long aim_bos_reqservice(struct aim_session_t *, struct aim_conn_t *, u_short); +u_long aim_bos_reqrights(struct aim_session_t *, struct aim_conn_t *); +u_long aim_bos_reqbuddyrights(struct aim_session_t *, struct aim_conn_t *); +u_long aim_bos_reqlocaterights(struct aim_session_t *, struct aim_conn_t *); +u_long aim_bos_reqicbmparaminfo(struct aim_session_t *, struct aim_conn_t *); + +/* aim_rxhandlers.c */ +int aim_rxdispatch(struct aim_session_t *); +int aim_authparse(struct aim_session_t *, struct command_rx_struct *); +int aim_handleredirect_middle(struct aim_session_t *, struct command_rx_struct *, ...); +int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *, ...); +int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...); +int aim_parse_generalerrs(struct aim_session_t *, struct command_rx_struct *command, ...); + +/* aim_im.c */ +#define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */ +#define AIM_IMFLAGS_ACK 0x02 /* request a receipt notice */ + +u_long aim_send_im(struct aim_session_t *, struct aim_conn_t *, char *, u_int, char *); +int aim_parse_incoming_im_middle(struct aim_session_t *, struct command_rx_struct *); +u_long aim_seticbmparam(struct aim_session_t *, struct aim_conn_t *conn); +int aim_parse_msgerror_middle(struct aim_session_t *, struct command_rx_struct *); + +/* aim_info.c */ +u_long aim_getinfo(struct aim_session_t *, struct aim_conn_t *, const char *); +int aim_extractuserinfo(u_char *, struct aim_userinfo_s *); +int aim_parse_userinfo_middle(struct aim_session_t *, struct command_rx_struct *); +int aim_parse_oncoming_middle(struct aim_session_t *, struct command_rx_struct *); +int aim_parse_offgoing_middle(struct aim_session_t *, struct command_rx_struct *); + +/* aim_auth.c */ +int aim_auth_sendcookie(struct aim_session_t *, struct aim_conn_t *, u_char *); +u_long aim_auth_clientready(struct aim_session_t *, struct aim_conn_t *); +u_long aim_auth_changepasswd(struct aim_session_t *, struct aim_conn_t *, char *, char *); + +/* aim_buddylist.c */ +u_long aim_add_buddy(struct aim_session_t *, struct aim_conn_t *, char *); +u_long aim_remove_buddy(struct aim_session_t *, struct aim_conn_t *, char *); + +/* aim_search.c */ +u_long aim_usersearch_address(struct aim_session_t *, struct aim_conn_t *, char *); +/* u_long aim_usersearch_name(struct aim_session_t *, struct aim_conn_t *, char *); */ + +/* aim_util.c */ +int aimutil_put8(u_char *, u_char); +u_char aimutil_get8(u_char *buf); +int aimutil_put16(u_char *, u_short); +u_short aimutil_get16(u_char *); +int aimutil_put32(u_char *, u_long); +u_long aimutil_get32(u_char *); +int aimutil_putstr(u_char *, const u_char *, int); +int aimutil_tokslen(char *toSearch, int index, char dl); +int aimutil_itemcnt(char *toSearch, char dl); +char *aimutil_itemidx(char *toSearch, int index, char dl); + +#endif /* __AIM_H__ */ + diff --git a/faim/aim_cbtypes.h b/faim/aim_cbtypes.h new file mode 100644 index 0000000..c900083 --- /dev/null +++ b/faim/aim_cbtypes.h @@ -0,0 +1,177 @@ +/* + * AIM Callback Types + * + */ +#ifndef __AIM_CBTYPES_H__ +#define __AIM_CBTYPES_H__ + +/* + * SNAC Families. + */ +#define AIM_CB_FAM_ACK 0x0000 +#define AIM_CB_FAM_GEN 0x0001 +#define AIM_CB_FAM_LOC 0x0002 +#define AIM_CB_FAM_BUD 0x0003 +#define AIM_CB_FAM_MSG 0x0004 +#define AIM_CB_FAM_ADS 0x0005 +#define AIM_CB_FAM_INV 0x0006 +#define AIM_CB_FAM_ADM 0x0007 +#define AIM_CB_FAM_POP 0x0008 +#define AIM_CB_FAM_BOS 0x0009 +#define AIM_CB_FAM_LOK 0x000a +#define AIM_CB_FAM_STS 0x000b +#define AIM_CB_FAM_TRN 0x000c +#define AIM_CB_FAM_CTN 0x000d /* ChatNav */ +#define AIM_CB_FAM_CHT 0x000e /* Chat */ +#define AIM_CB_FAM_SPECIAL 0xffff /* Internal libfaim use */ + +/* + * SNAC Family: Ack. + * + * Not really a family, but treating it as one really + * helps it fit into the libfaim callback structure better. + * + */ +#define AIM_CB_ACK_ACK 0x0001 + +/* + * SNAC Family: General. + */ +#define AIM_CB_GEN_ERROR 0x0001 +#define AIM_CB_GEN_CLIENTREADY 0x0002 +#define AIM_CB_GEN_SERVERREADY 0x0003 +#define AIM_CB_GEN_SERVICEREQ 0x0004 +#define AIM_CB_GEN_REDIRECT 0x0005 +#define AIM_CB_GEN_RATEINFOREQ 0x0006 +#define AIM_CB_GEN_RATEINFO 0x0007 +#define AIM_CB_GEN_RATEINFOACK 0x0008 +#define AIM_CB_GEN_RATECHANGE 0x000a +#define AIM_CB_GEN_SERVERPAUSE 0x000b +#define AIM_CB_GEN_SERVERRESUME 0x000d +#define AIM_CB_GEN_REQSELFINFO 0x000e +#define AIM_CB_GEN_SELFINFO 0x000f +#define AIM_CB_GEN_EVIL 0x0010 +#define AIM_CB_GEN_SETIDLE 0x0011 +#define AIM_CB_GEN_MIGRATIONREQ 0x0012 +#define AIM_CB_GEN_MOTD 0x0013 +#define AIM_CB_GEN_SETPRIVFLAGS 0x0014 +#define AIM_CB_GEN_WELLKNOWNURL 0x0015 +#define AIM_CB_GEN_NOP 0x0016 +#define AIM_CB_GEN_DEFAULT 0xffff + +/* + * SNAC Family: Location Services. + */ +#define AIM_CB_LOC_ERROR 0x0001 +#define AIM_CB_LOC_REQRIGHTS 0x0002 +#define AIM_CB_LOC_RIGHTSINFO 0x0003 +#define AIM_CB_LOC_SETUSERINFO 0x0004 +#define AIM_CB_LOC_REQUSERINFO 0x0005 +#define AIM_CB_LOC_USERINFO 0x0006 +#define AIM_CB_LOC_WATCHERSUBREQ 0x0007 +#define AIM_CB_LOC_WATCHERNOT 0x0008 +#define AIM_CB_LOC_DEFAULT 0xffff + +/* + * SNAC Family: Buddy List Management Services. + */ +#define AIM_CB_BUD_ERROR 0x0001 +#define AIM_CB_BUD_REQRIGHTS 0x0002 +#define AIM_CB_BUD_RIGHTSINFO 0x0003 +#define AIM_CB_BUD_ADDBUDDY 0x0004 +#define AIM_CB_BUD_REMBUDDY 0x0005 +#define AIM_CB_BUD_REJECT 0x000a +#define AIM_CB_BUD_ONCOMING 0x000b +#define AIM_CB_BUD_OFFGOING 0x000c +#define AIM_CB_BUD_DEFAULT 0xffff + +/* + * SNAC Family: Messeging Services. + */ +#define AIM_CB_MSG_ERROR 0x0001 +#define AIM_CB_MSG_PARAMINFO 0x0005 +#define AIM_CB_MSG_INCOMING 0x0007 +#define AIM_CB_MSG_EVIL 0x0009 +#define AIM_CB_MSG_MISSEDCALL 0x000a +#define AIM_CB_MSG_CLIENTERROR 0x000b +#define AIM_CB_MSG_ACK 0x000c +#define AIM_CB_MSG_DEFAULT 0xffff + +/* + * SNAC Family: Advertisement Services + */ +#define AIM_CB_ADS_ERROR 0x0001 +#define AIM_CB_ADS_DEFAULT 0xffff + +/* + * SNAC Family: Invitation Services. + */ +#define AIM_CB_INV_ERROR 0x0001 +#define AIM_CB_INV_DEFAULT 0xffff + +/* + * SNAC Family: Administrative Services. + */ +#define AIM_CB_ADM_ERROR 0x0001 +#define AIM_CB_ADM_INFOCHANGE_REPLY 0x0005 +#define AIM_CB_ADM_DEFAULT 0xffff + +/* + * SNAC Family: Popup Messages + */ +#define AIM_CB_POP_ERROR 0x0001 +#define AIM_CB_POP_DEFAULT 0xffff + +/* + * SNAC Family: Misc BOS Services. + */ +#define AIM_CB_BOS_ERROR 0x0001 +#define AIM_CB_BOS_DEFAULT 0xffff + +/* + * SNAC Family: User Lookup Services + */ +#define AIM_CB_LOK_ERROR 0x0001 +#define AIM_CB_LOK_DEFAULT 0xffff + +/* + * SNAC Family: User Status Services + */ +#define AIM_CB_STS_ERROR 0x0001 +#define AIM_CB_STS_SETREPORTINTERVAL 0x0002 +#define AIM_CB_STS_REPORTACK 0x0004 +#define AIM_CB_STS_DEFAULT 0xffff + +/* + * SNAC Family: Translation Services + */ +#define AIM_CB_TRN_ERROR 0x0001 +#define AIM_CB_TRN_DEFAULT 0xffff + +/* + * SNAC Family: Chat Navigation Services + */ +#define AIM_CB_CTN_ERROR 0x0001 +#define AIM_CB_CTN_DEFAULT 0xffff + +/* + * SNAC Family: Chat Services + */ +#define AIM_CB_CHT_ERROR 0x0001 +#define AIM_CB_CHT_DEFAULT 0xffff + +/* + * SNAC Family: Internal Messages + * + * This isn't truely a SNAC family either, but using + * these, we can integrated non-SNAC services into + * the SNAC-centered libfaim callback structure. + * + */ +#define AIM_CB_SPECIAL_AUTHSUCCESS 0x0001 +#define AIM_CB_SPECIAL_AUTHOTHER 0x0002 +#define AIM_CB_SPECIAL_UNKNOWN 0xffff +#define AIM_CB_SPECIAL_DEFAULT AIM_CB_SPECIAL_UNKNOWN + + +#endif/*__AIM_CBTYPES_H__ */ diff --git a/faim/faimconfig.h b/faim/faimconfig.h new file mode 100644 index 0000000..81ff626 --- /dev/null +++ b/faim/faimconfig.h @@ -0,0 +1,80 @@ +/* + * faimconfig.h + * + * Contains various compile-time options that apply _only to libfaim. + * Note that setting any of these options in a frontend header does not imply + * that they'll get set here. Notably, the 'debug' of this file is _not_ + * the same as the frontend 'debug'. They can be different values. + * + */ + +#ifndef __FAIMCONFIG_H__ +#define __FAIMCONFIG_H__ + +/* + * set debug to be > 0 if you want debugging information spewing + * on the attached tty. set to 0 for daily use. this value + * is _not_ inherited by the frontend, only this backend. + * + * Default: 0 +*/ +#define debug 0 + +/* + * Maximum number of connections the library can simultaneously + * handle. Five is fairly arbitrary. Only one client that I + * know of uses more than one concurrently anyway (which means + * its only lightly tested too). + * + * Default: 5 + * + */ +#define AIM_CONN_MAX 5 + +/* + * define TIS_TELNET_PROXY if you have a TIS firewall (Gauntlet) and + * you want to use FAIM through the firewall + * + * XXX: The TIS firewall code hasn't existed, let alone worked, + * in many, many months. I'd be happy to take fixes. + * + * Default: undefined + */ +#undef TIS_TELNET_PROXY "proxy.mydomain.com" + +/* + * USE_SNAC_FOR_IMS is an old feature that allowed better + * tracking of error messages by caching SNAC IDs of outgoing + * ICBMs and comparing them to incoming errors. However, + * its a helluvalot of overhead for something that should + * rarely happen. + * + * Default: defined. + * + */ +#define USE_SNAC_FOR_IMS + +/* + * Default Authorizer server name and TCP port for the OSCAR farm. + * + * You shouldn't need to change this unless you're writing + * your own server. + * + * Note that only one server is needed to start the whole + * AIM process. The later server addresses come from + * the authorizer service. + * + */ +#define FAIM_LOGIN_SERVER "login.oscar.aol.com" +#define FAIM_LOGIN_PORT 5190 + +/* + * MAX_READ_ERROR can be decreased if you find dead connections + * lingering around, and not getting detected, for too long. + * + * Default: 100 + * + */ +#define MAX_READ_ERROR 100 + +#endif /* __FAIMCONFIG_H__ */