diff options
| author | Linus Nordberg <linus@nordberg.se> | 2013-01-24 14:06:35 +0100 | 
|---|---|---|
| committer | Linus Nordberg <linus@nordberg.se> | 2013-01-24 14:06:35 +0100 | 
| commit | 1e3a2613b356bf542fd75c198e9c9813e24f08d1 (patch) | |
| tree | 6a3f90c5a50fbf8ccb202dea54dff847a7702f7d /lib/include | |
| parent | 49047aa9d70c81b91ebe2446a6e84e659f59506c (diff) | |
Rename most 'package' to 'message'.
RADIUS (RFC2865) is defined to be transported over UDP so the term
"radius packet" makes a lot of sense. RADIUS/TCP (RFC6613) and
RADIUS/TLS (RFC6614), a.k.a. RadSec, use stream transport protocols
though. The term "message" doesn't imply any kind of transport -- a
message can be sent using datagrams as well as in a stream.
This (large) commit changes 'package' to 'message' where it makes
sense. It does not touch the 'radius' subdirectory. It includes
preprocessor directives (#define) to make the public interface
compatible with previous releases of the library.
Diffstat (limited to 'lib/include')
| -rw-r--r-- | lib/include/radsec/radsec-impl.h | 14 | ||||
| -rw-r--r-- | lib/include/radsec/radsec.h | 75 | ||||
| -rw-r--r-- | lib/include/radsec/request-impl.h | 2 | ||||
| -rw-r--r-- | lib/include/radsec/request.h | 15 | 
4 files changed, 60 insertions, 46 deletions
diff --git a/lib/include/radsec/radsec-impl.h b/lib/include/radsec/radsec-impl.h index 6c02dcf..9f8ebbb 100644 --- a/lib/include/radsec/radsec-impl.h +++ b/lib/include/radsec/radsec-impl.h @@ -107,7 +107,7 @@ struct rs_connection {      /* UDP transport specifics.  */      struct event *wev;		/* Write event (for UDP).  */      struct event *rev;		/* Read event (for UDP).  */ -    struct rs_packet *out_queue; /* Queue for outgoing UDP packets.  */ +    struct rs_message *out_queue; /* Queue for outgoing UDP packets.  */  #if defined(RS_ENABLE_TLS)      /* TLS specifics.  */      SSL_CTX *tls_ctx; @@ -115,20 +115,20 @@ struct rs_connection {  #endif  }; -enum rs_packet_flags { -    RS_PACKET_HEADER_READ, -    RS_PACKET_RECEIVED, -    RS_PACKET_SENT, +enum rs_message_flags { +    RS_MESSAGE_HEADER_READ, +    RS_MESSAGE_RECEIVED, +    RS_MESSAGE_SENT,  };  struct radius_packet; -struct rs_packet { +struct rs_message {      struct rs_connection *conn;      unsigned int flags;      uint8_t hdr[RS_HEADER_LEN];      struct radius_packet *rpkt;	/* FreeRADIUS object.  */ -    struct rs_packet *next;	/* Used for UDP output queue.  */ +    struct rs_message *next;	/* Used for UDP output queue.  */  };  #if defined (__cplusplus) diff --git a/lib/include/radsec/radsec.h b/lib/include/radsec/radsec.h index f615db9..e5352be 100644 --- a/lib/include/radsec/radsec.h +++ b/lib/include/radsec/radsec.h @@ -38,7 +38,7 @@ enum rs_error_code {      RSE_BADAUTH = 12,      RSE_INTERNAL = 13,      RSE_SSLERR = 14,		/* OpenSSL error.  */ -    RSE_INVALID_PKT = 15, +    RSE_INVALID_MSG = 15,      RSE_TIMEOUT_CONN = 16,	/* Connection timeout.  */      RSE_INVAL = 17,		/* Invalid argument.  */      RSE_TIMEOUT_IO = 18,	/* I/O timeout.  */ @@ -118,10 +118,20 @@ typedef enum rs_attr_type_t {  extern "C" {  #endif +/* Backwards compatible with 0.0.2. */ +#define RSE_INVALID_PKT RSE_INVALID_MSG  #define rs_packet rs_message  #define rs_conn_packet_received_cb rs_conn_message_received_cb  #define rs_conn_packet_sent_cb rs_conn_message_sent_cb  #define rs_conn_receive_packet rs_conn_receive_message +#define rs_dump_packet rs_dump_message +#define rs_packet_append_avp rs_message_append_avp +#define rs_packet_avps rs_message_avps +#define rs_packet_code rs_message_code +#define rs_packet_create rs_message_create +#define rs_packet_create_authn_request rs_message_create_authn_request +#define rs_packet_destroy rs_message_destroy +#define rs_packet_send rs_message_send  /* Data types.  */  struct rs_context;		/* radsec-impl.h */ @@ -156,7 +166,7 @@ struct rs_conn_callbacks {      /** Callback invoked when the connection has been torn down.  */      rs_conn_disconnected_cb disconnected_cb;      /** Callback invoked when a message was received.  */ -    rs_conn_packet_message_cb received_cb; +    rs_conn_message_received_cb received_cb;      /** Callback invoked when a message was successfully sent.  */      rs_conn_message_sent_cb sent_cb;  }; @@ -295,58 +305,59 @@ void rs_peer_set_timeout(struct rs_peer *peer, int timeout);  void rs_peer_set_retries(struct rs_peer *peer, int retries);  /************/ -/* Packet.  */ +/* Message.  */  /************/ -/** Create a packet associated with connection \a conn.  */ -int rs_packet_create(struct rs_connection *conn, struct rs_packet **pkt_out); +/** Create a message associated with connection \a conn.  */ +int rs_message_create(struct rs_connection *conn, struct rs_message **pkt_out); -/** Free all memory allocated for packet \a pkt.  */ -void rs_packet_destroy(struct rs_packet *pkt); +/** Free all memory allocated for message \a msg.  */ +void rs_message_destroy(struct rs_message *msg); -/** Send packet \a pkt on the connection associated with \a pkt.  \a -    user_data is sent to the \a rs_conn_packet_received_cb callback -    registered with the connection.  If no callback is registered with -    the connection, the event loop is run by \a rs_packet_send and it -    blocks until the packet has been succesfully sent. +/** Send message \a msg on the connection associated with \a msg. +    \a user_data is sent to the \a rs_conn_message_received_cb callback +    registered with the connection. If no callback is registered with +    the connection, the event loop is run by \a rs_message_send and it +    blocks until the message has been succesfully sent.      \return On success, RSE_OK (0) is returned.  On error, !0 is      returned and a struct \a rs_error is pushed on the error stack for      the connection.  The error can be accessed using \a      rs_err_conn_pop.  */ -int rs_packet_send(struct rs_packet *pkt, void *user_data); +int rs_message_send(struct rs_message *msg, void *user_data); -/** Create a RADIUS authentication request packet associated with +/** Create a RADIUS authentication request message associated with      connection \a conn.  Optionally, User-Name and User-Password -    attributes are added to the packet using the data in \a user_name, +    attributes are added to the message using the data in \a user_name,      \a user_pw and \a secret where \secret is the RADIUS shared      secret. */ -int rs_packet_create_authn_request(struct rs_connection *conn, -				   struct rs_packet **pkt, -				   const char *user_name, -				   const char *user_pw, -                                   const char *secret); +int rs_message_create_authn_request(struct rs_connection *conn, +                                    struct rs_message **msg, +                                    const char *user_name, +                                    const char *user_pw, +                                    const char *secret); -/*** Append \a tail to packet \a pkt.  */ +/*** Append \a tail to message \a msg.  */  int -rs_packet_append_avp(struct rs_packet *pkt, -		     unsigned int attribute, unsigned int vendor, -		     const void *data, size_t data_len); +rs_message_append_avp(struct rs_message *msg, +                      unsigned int attribute, unsigned int vendor, +                      const void *data, size_t data_len); -/*** Get pointer to \a pkt attribute value pairs. */ +/*** Get pointer to \a msg attribute value pairs. */  void -rs_packet_avps(struct rs_packet *pkt, rs_avp ***vps); +rs_message_avps(struct rs_message *msg, rs_avp ***vps); -/*** Get RADIUS packet type of \a pkt. */ +/*** Get RADIUS message type of \a msg. */  unsigned int -rs_packet_code(struct rs_packet *pkt); +rs_message_code(struct rs_message *msg); -/*** Get RADIUS AVP from \a pkt. */ +/*** Get RADIUS AVP from \a msg. */  rs_const_avp * -rs_packet_find_avp(struct rs_packet *pkt, unsigned int attr, unsigned int vendor); +rs_message_find_avp(struct rs_message *msg, unsigned int attr, +                    unsigned int vendor); -/*** Set packet identifier in \a pkt; returns old identifier */ +/*** Set packet identifier in \a msg; returns old identifier */  int -rs_packet_set_id (struct rs_packet *pkt, int id); +rs_message_set_id (struct rs_message *msg, int id);  /************/  /* Config.  */ diff --git a/lib/include/radsec/request-impl.h b/lib/include/radsec/request-impl.h index bb61dd6..9af1394 100644 --- a/lib/include/radsec/request-impl.h +++ b/lib/include/radsec/request-impl.h @@ -11,7 +11,7 @@ struct rs_request  {    struct rs_connection *conn;    struct event *timer; -  struct rs_packet *req_msg; +  struct rs_message *req_msg;    struct rs_conn_callbacks saved_cb;    void *saved_user_data;  }; diff --git a/lib/include/radsec/request.h b/lib/include/radsec/request.h index f0151f8..05b5daa 100644 --- a/lib/include/radsec/request.h +++ b/lib/include/radsec/request.h @@ -6,6 +6,10 @@  #ifndef _RADSEC_REQUEST_H_  #define _RADSEC_REQUEST_H_ 1 +/* Backwards compatible with 0.0.2. */ +#define rs_request_add_reqpkt rs_request_add_reqmsg +#define rs_request_get_reqpkt rs_request_get_reqmsg +  struct rs_request;  #if defined (__cplusplus) @@ -15,9 +19,8 @@ extern "C" {  /** Create a request associated with connection \a conn.  */  int rs_request_create(struct rs_connection *conn, struct rs_request **req_out); -/** Add RADIUS request message \a req_msg to request \a req. -    FIXME: Rename to rs_request_add_reqmsg?  */ -void rs_request_add_reqpkt(struct rs_request *req, struct rs_packet *req_msg); +/** Add RADIUS request message \a req_msg to request \a req. */ +void rs_request_add_reqmsg(struct rs_request *req, struct rs_message *req_msg);  /** Create a request associated with connection \a conn containing a      newly created RADIUS authentication message, possibly with @@ -35,15 +38,15 @@ int rs_request_create_authn(struct rs_connection *conn,      response is put in \a resp_msg (if not NULL).  NOTE: At present,      no more than one outstanding request to a given realm is      supported.  This will change in a future version.  */ -int rs_request_send(struct rs_request *req, struct rs_packet **resp_msg); +int rs_request_send(struct rs_request *req, struct rs_message **resp_msg);  /** Free all memory allocated by request \a req including any request -    packet associated with the request.  Note that a request must be +    message associated with the request.  Note that a request must be      freed before its associated connection can be freed.  */  void rs_request_destroy(struct rs_request *req);  /** Return request message in request \a req.  */ -struct rs_packet *rs_request_get_reqmsg(const struct rs_request *req); +struct rs_message *rs_request_get_reqmsg(const struct rs_request *req);  #if defined (__cplusplus)  }  | 
