Skip to content

Commit 29fa57e

Browse files
arr2036arr2036
committed
Basic doxygen comments. Addresses #31 
1 parent 4c6bd94 commit 29fa57e

File tree

15 files changed

+533
-660
lines changed

15 files changed

+533
-660
lines changed

‎include/freeradius-client.h‎

Lines changed: 132 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
#define BUFFER_LEN 8192
5353

5454
#define NAME_LENGTH 32
55-
#define GETSTR_LENGTH 128 /* must be bigger than AUTH_PASS_LEN */
55+
#define GETSTR_LENGTH 128 //!< must be bigger than AUTH_PASS_LEN.
5656

5757
#define MAX_SECRET_LENGTH (3 * 16) /* MUST be multiple of 16 */
5858

@@ -139,131 +139,131 @@ typedef struct rc_conf rc_handle;
139139

140140
/* standard RADIUS attribute-value pairs */
141141

142-
#define PW_USER_NAME 1 /* string */
143-
#define PW_USER_PASSWORD 2 /* string */
144-
#define PW_CHAP_PASSWORD 3 /* string */
145-
#define PW_NAS_IP_ADDRESS 4 /* ipaddr */
146-
#define PW_NAS_PORT 5 /* integer */
147-
#define PW_SERVICE_TYPE 6 /* integer */
148-
#define PW_FRAMED_PROTOCOL 7 /* integer */
149-
#define PW_FRAMED_IP_ADDRESS 8 /* ipaddr */
150-
#define PW_FRAMED_IP_NETMASK 9 /* ipaddr */
151-
#define PW_FRAMED_ROUTING 10 /* integer */
152-
#define PW_FILTER_ID 11 /* string */
153-
#define PW_FRAMED_MTU 12 /* integer */
154-
#define PW_FRAMED_COMPRESSION 13 /* integer */
155-
#define PW_LOGIN_IP_HOST 14 /* ipaddr */
156-
#define PW_LOGIN_SERVICE 15 /* integer */
157-
#define PW_LOGIN_PORT 16 /* integer */
158-
#define PW_OLD_PASSWORD 17 /* string */ /* deprecated */
159-
#define PW_REPLY_MESSAGE 18 /* string */
160-
#define PW_LOGIN_CALLBACK_NUMBER 19 /* string */
161-
#define PW_FRAMED_CALLBACK_ID 20 /* string */
162-
#define PW_EXPIRATION 21 /* date */ /* deprecated */
163-
#define PW_FRAMED_ROUTE 22 /* string */
164-
#define PW_FRAMED_IPX_NETWORK 23 /* integer */
165-
#define PW_STATE 24 /* string */
166-
#define PW_CLASS 25 /* string */
167-
#define PW_VENDOR_SPECIFIC 26 /* string */
168-
#define PW_SESSION_TIMEOUT 27 /* integer */
169-
#define PW_IDLE_TIMEOUT 28 /* integer */
170-
#define PW_TERMINATION_ACTION 29 /* integer */
171-
#define PW_CALLED_STATION_ID 30 /* string */
172-
#define PW_CALLING_STATION_ID 31 /* string */
173-
#define PW_NAS_IDENTIFIER 32 /* string */
174-
#define PW_PROXY_STATE 33 /* string */
175-
#define PW_LOGIN_LAT_SERVICE 34 /* string */
176-
#define PW_LOGIN_LAT_NODE 35 /* string */
177-
#define PW_LOGIN_LAT_GROUP 36 /* string */
178-
#define PW_FRAMED_APPLETALK_LINK 37 /* integer */
179-
#define PW_FRAMED_APPLETALK_NETWORK 38 /* integer */
180-
#define PW_FRAMED_APPLETALK_ZONE 39 /* string */
181-
#define PW_ACCT_STATUS_TYPE 40 /* integer */
182-
#define PW_ACCT_DELAY_TIME 41 /* integer */
183-
#define PW_ACCT_INPUT_OCTETS 42 /* integer */
184-
#define PW_ACCT_OUTPUT_OCTETS 43 /* integer */
185-
#define PW_ACCT_SESSION_ID 44 /* string */
186-
#define PW_ACCT_AUTHENTIC 45 /* integer */
187-
#define PW_ACCT_SESSION_TIME 46 /* integer */
188-
#define PW_ACCT_INPUT_PACKETS 47 /* integer */
189-
#define PW_ACCT_OUTPUT_PACKETS 48 /* integer */
190-
#define PW_ACCT_TERMINATE_CAUSE 49 /* integer */
191-
#define PW_ACCT_MULTI_SESSION_ID 50 /* string */
192-
#define PW_ACCT_LINK_COUNT 51 /* integer */
193-
#define PW_ACCT_INPUT_GIGAWORDS 52 /* integer */
194-
#define PW_ACCT_OUTPUT_GIGAWORDS 53 /* integer */
195-
#define PW_EVENT_TIMESTAMP 55 /* integer */
196-
#define PW_EGRESS_VLANID 56 /* string */
197-
#define PW_INGRESS_FILTERS 57 /* integer */
198-
#define PW_EGRESS_VLAN_NAME 58 /* string */
199-
#define PW_USER_PRIORITY_TABLE 59 /* string */
200-
#define PW_CHAP_CHALLENGE 60 /* string */
201-
#define PW_NAS_PORT_TYPE 61 /* integer */
202-
#define PW_PORT_LIMIT 62 /* integer */
203-
#define PW_LOGIN_LAT_PORT 63 /* string */
204-
#define PW_TUNNEL_TYPE 64 /* string */
205-
#define PW_TUNNEL_MEDIUM_TYPE 65 /* integer */
206-
#define PW_TUNNEL_CLIENT_ENDPOINT 66 /* string */
207-
#define PW_TUNNEL_SERVER_ENDPOINT 67 /* string */
208-
#define PW_ACCT_TUNNEL_CONNECTION 68 /* string */
209-
#define PW_TUNNEL_PASSWORD 69 /* string */
210-
#define PW_ARAP_PASSWORD 70 /* string */
211-
#define PW_ARAP_FEATURES 71 /* string */
212-
#define PW_ARAP_ZONE_ACCESS 72 /* integer */
213-
#define PW_ARAP_SECURITY 73 /* integer */
214-
#define PW_ARAP_SECURITY_DATA 74 /* string */
215-
#define PW_PASSWORD_RETRY 75 /* integer */
216-
#define PW_PROMPT 76 /* integer */
217-
#define PW_CONNECT_INFO 77 /* string */
218-
#define PW_CONFIGURATION_TOKEN 78 /* string */
219-
#define PW_EAP_MESSAGE 79 /* string */
220-
#define PW_MESSAGE_AUTHENTICATOR 80 /* string */
221-
#define PW_TUNNEL_PRIVATE_GROUP_ID 81 /* string */
222-
#define PW_TUNNEL_ASSIGNMENT_ID 82 /* string */
223-
#define PW_TUNNEL_PREFERENCE 83 /* string */
224-
#define PW_ARAP_CHALLENGE_RESPONSE 84 /* string */
225-
#define PW_ACCT_INTERIM_INTERVAL 85 /* integer */
226-
#define PW_ACCT_TUNNEL_PACKETS_LOST 86 /* integer */
227-
#define PW_NAS_PORT_ID_STRING 87 /* string */
228-
#define PW_FRAMED_POOL 88 /* string */
229-
#define PW_CHARGEABLE_USER_IDENTITY 89 /* string */
230-
#define PW_CUI 89 /* string */
231-
#define PW_TUNNEL_CLIENT_AUTH_ID 90 /* string */
232-
#define PW_TUNNEL_SERVER_AUTH_ID 91 /* string */
233-
#define PW_NAS_FILTER_RULE 92 /* string */
234-
#define PW_ORIGINATING_LINE_INFO 94 /* string */
235-
#define PW_NAS_IPV6_ADDRESS 95 /* string */
236-
#define PW_FRAMED_INTERFACE_ID 96 /* string */
237-
#define PW_FRAMED_IPV6_PREFIX 97 /* string */
238-
#define PW_LOGIN_IPV6_HOST 98 /* string */
239-
#define PW_FRAMED_IPV6_ROUTE 99 /* string */
240-
#define PW_FRAMED_IPV6_POOL 100 /* string */
241-
#define PW_ERROR_CAUSE 101 /* integer */
242-
#define PW_EAP_KEY_NAME 102 /* string */
243-
244-
#define PW_FRAMED_IPV6_ADDRESS 168 /* ipaddr6 */
245-
#define PW_DNS_SERVER_IPV6_ADDRESS 169 /* ipaddr6 */
246-
#define PW_ROUTE_IPV6_INFORMATION 170 /* ipv6prefix */
142+
#define PW_USER_NAME 1 //!< string.
143+
#define PW_USER_PASSWORD 2 //!< string.
144+
#define PW_CHAP_PASSWORD 3 //!< string.
145+
#define PW_NAS_IP_ADDRESS 4 //!< ipaddr.
146+
#define PW_NAS_PORT 5 //!< integer.
147+
#define PW_SERVICE_TYPE 6 //!< integer.
148+
#define PW_FRAMED_PROTOCOL 7 //!< integer.
149+
#define PW_FRAMED_IP_ADDRESS 8 //!< ipaddr.
150+
#define PW_FRAMED_IP_NETMASK 9 //!< ipaddr.
151+
#define PW_FRAMED_ROUTING 10 //!< integer.
152+
#define PW_FILTER_ID 11 //!< string.
153+
#define PW_FRAMED_MTU 12 //!< integer.
154+
#define PW_FRAMED_COMPRESSION 13 //!< integer.
155+
#define PW_LOGIN_IP_HOST 14 //!< ipaddr.
156+
#define PW_LOGIN_SERVICE 15 //!< integer.
157+
#define PW_LOGIN_PORT 16 //!< integer.
158+
#define PW_OLD_PASSWORD 17 //!< string */ /* deprecated.
159+
#define PW_REPLY_MESSAGE 18 //!< string.
160+
#define PW_LOGIN_CALLBACK_NUMBER 19 //!< string.
161+
#define PW_FRAMED_CALLBACK_ID 20 //!< string.
162+
#define PW_EXPIRATION 21 //!< date */ /* deprecated.
163+
#define PW_FRAMED_ROUTE 22 //!< string.
164+
#define PW_FRAMED_IPX_NETWORK 23 //!< integer.
165+
#define PW_STATE 24 //!< string.
166+
#define PW_CLASS 25 //!< string.
167+
#define PW_VENDOR_SPECIFIC 26 //!< string.
168+
#define PW_SESSION_TIMEOUT 27 //!< integer.
169+
#define PW_IDLE_TIMEOUT 28 //!< integer.
170+
#define PW_TERMINATION_ACTION 29 //!< integer.
171+
#define PW_CALLED_STATION_ID 30 //!< string.
172+
#define PW_CALLING_STATION_ID 31 //!< string.
173+
#define PW_NAS_IDENTIFIER 32 //!< string.
174+
#define PW_PROXY_STATE 33 //!< string.
175+
#define PW_LOGIN_LAT_SERVICE 34 //!< string.
176+
#define PW_LOGIN_LAT_NODE 35 //!< string.
177+
#define PW_LOGIN_LAT_GROUP 36 //!< string.
178+
#define PW_FRAMED_APPLETALK_LINK 37 //!< integer.
179+
#define PW_FRAMED_APPLETALK_NETWORK 38 //!< integer.
180+
#define PW_FRAMED_APPLETALK_ZONE 39 //!< string.
181+
#define PW_ACCT_STATUS_TYPE 40 //!< integer.
182+
#define PW_ACCT_DELAY_TIME 41 //!< integer.
183+
#define PW_ACCT_INPUT_OCTETS 42 //!< integer.
184+
#define PW_ACCT_OUTPUT_OCTETS 43 //!< integer.
185+
#define PW_ACCT_SESSION_ID 44 //!< string.
186+
#define PW_ACCT_AUTHENTIC 45 //!< integer.
187+
#define PW_ACCT_SESSION_TIME 46 //!< integer.
188+
#define PW_ACCT_INPUT_PACKETS 47 //!< integer.
189+
#define PW_ACCT_OUTPUT_PACKETS 48 //!< integer.
190+
#define PW_ACCT_TERMINATE_CAUSE 49 //!< integer.
191+
#define PW_ACCT_MULTI_SESSION_ID 50 //!< string.
192+
#define PW_ACCT_LINK_COUNT 51 //!< integer.
193+
#define PW_ACCT_INPUT_GIGAWORDS 52 //!< integer.
194+
#define PW_ACCT_OUTPUT_GIGAWORDS 53 //!< integer.
195+
#define PW_EVENT_TIMESTAMP 55 //!< integer.
196+
#define PW_EGRESS_VLANID 56 //!< string.
197+
#define PW_INGRESS_FILTERS 57 //!< integer.
198+
#define PW_EGRESS_VLAN_NAME 58 //!< string.
199+
#define PW_USER_PRIORITY_TABLE 59 //!< string.
200+
#define PW_CHAP_CHALLENGE 60 //!< string.
201+
#define PW_NAS_PORT_TYPE 61 //!< integer.
202+
#define PW_PORT_LIMIT 62 //!< integer.
203+
#define PW_LOGIN_LAT_PORT 63 //!< string.
204+
#define PW_TUNNEL_TYPE 64 //!< string.
205+
#define PW_TUNNEL_MEDIUM_TYPE 65 //!< integer.
206+
#define PW_TUNNEL_CLIENT_ENDPOINT 66 //!< string.
207+
#define PW_TUNNEL_SERVER_ENDPOINT 67 //!< string.
208+
#define PW_ACCT_TUNNEL_CONNECTION 68 //!< string.
209+
#define PW_TUNNEL_PASSWORD 69 //!< string.
210+
#define PW_ARAP_PASSWORD 70 //!< string.
211+
#define PW_ARAP_FEATURES 71 //!< string.
212+
#define PW_ARAP_ZONE_ACCESS 72 //!< integer.
213+
#define PW_ARAP_SECURITY 73 //!< integer.
214+
#define PW_ARAP_SECURITY_DATA 74 //!< string.
215+
#define PW_PASSWORD_RETRY 75 //!< integer.
216+
#define PW_PROMPT 76 //!< integer.
217+
#define PW_CONNECT_INFO 77 //!< string.
218+
#define PW_CONFIGURATION_TOKEN 78 //!< string.
219+
#define PW_EAP_MESSAGE 79 //!< string.
220+
#define PW_MESSAGE_AUTHENTICATOR 80 //!< string.
221+
#define PW_TUNNEL_PRIVATE_GROUP_ID 81 //!< string.
222+
#define PW_TUNNEL_ASSIGNMENT_ID 82 //!< string.
223+
#define PW_TUNNEL_PREFERENCE 83 //!< string.
224+
#define PW_ARAP_CHALLENGE_RESPONSE 84 //!< string.
225+
#define PW_ACCT_INTERIM_INTERVAL 85 //!< integer.
226+
#define PW_ACCT_TUNNEL_PACKETS_LOST 86 //!< integer.
227+
#define PW_NAS_PORT_ID_STRING 87 //!< string.
228+
#define PW_FRAMED_POOL 88 //!< string.
229+
#define PW_CHARGEABLE_USER_IDENTITY 89 //!< string.
230+
#define PW_CUI 89 //!< string.
231+
#define PW_TUNNEL_CLIENT_AUTH_ID 90 //!< string.
232+
#define PW_TUNNEL_SERVER_AUTH_ID 91 //!< string.
233+
#define PW_NAS_FILTER_RULE 92 //!< string.
234+
#define PW_ORIGINATING_LINE_INFO 94 //!< string.
235+
#define PW_NAS_IPV6_ADDRESS 95 //!< string.
236+
#define PW_FRAMED_INTERFACE_ID 96 //!< string.
237+
#define PW_FRAMED_IPV6_PREFIX 97 //!< string.
238+
#define PW_LOGIN_IPV6_HOST 98 //!< string.
239+
#define PW_FRAMED_IPV6_ROUTE 99 //!< string.
240+
#define PW_FRAMED_IPV6_POOL 100 //!< string.
241+
#define PW_ERROR_CAUSE 101 //!< integer.
242+
#define PW_EAP_KEY_NAME 102 //!< string.
243+
244+
#define PW_FRAMED_IPV6_ADDRESS 168 //!< ipaddr6.
245+
#define PW_DNS_SERVER_IPV6_ADDRESS 169 //!< ipaddr6.
246+
#define PW_ROUTE_IPV6_INFORMATION 170 //!< ipv6prefix.
247247
248248
/* Experimental SIP-specific attributes (draft-sterman-aaa-sip-00.txt etc) */
249249

250-
#define PW_DIGEST_RESPONSE 206 /* string */
251-
#define PW_DIGEST_ATTRIBUTES 207 /* string */
252-
#define PW_DIGEST_REALM 1063 /* string */
253-
#define PW_DIGEST_NONCE 1064 /* string */
254-
#define PW_DIGEST_METHOD 1065 /* string */
255-
#define PW_DIGEST_URI 1066 /* string */
256-
#define PW_DIGEST_QOP 1067 /* string */
257-
#define PW_DIGEST_ALGORITHM 1068 /* string */
258-
#define PW_DIGEST_BODY_DIGEST 1069 /* string */
259-
#define PW_DIGEST_CNONCE 1070 /* string */
260-
#define PW_DIGEST_NONCE_COUNT 1071 /* string */
261-
#define PW_DIGEST_USER_NAME 1072 /* string */
250+
#define PW_DIGEST_RESPONSE 206 //!< string.
251+
#define PW_DIGEST_ATTRIBUTES 207 //!< string.
252+
#define PW_DIGEST_REALM 1063 //!< string.
253+
#define PW_DIGEST_NONCE 1064 //!< string.
254+
#define PW_DIGEST_METHOD 1065 //!< string.
255+
#define PW_DIGEST_URI 1066 //!< string.
256+
#define PW_DIGEST_QOP 1067 //!< string.
257+
#define PW_DIGEST_ALGORITHM 1068 //!< string.
258+
#define PW_DIGEST_BODY_DIGEST 1069 //!< string.
259+
#define PW_DIGEST_CNONCE 1070 //!< string.
260+
#define PW_DIGEST_NONCE_COUNT 1071 //!< string.
261+
#define PW_DIGEST_USER_NAME 1072 //!< string.
262262

263263
/* Merit Experimental Extensions */
264264

265-
#define PW_USER_ID 222 /* string */
266-
#define PW_USER_REALM 223 /* string */
265+
#define PW_USER_ID 222 //!< string.
266+
#define PW_USER_REALM 223 //!< string.
267267

268268
/* Integer Translations */
269269

@@ -316,7 +316,7 @@ typedef struct rc_conf rc_handle;
316316

317317
/* PROHIBIT PROTOCOL */
318318

319-
#define PW_DUMB 0 /* 1 and 2 are defined in FRAMED PROTOCOLS */
319+
#define PW_DUMB 0 //!< 1 and 2 are defined in FRAMED PROTOCOLS.
320320
#define PW_AUTH_ONLY 3
321321
#define PW_ALL 255
322322

@@ -371,9 +371,9 @@ typedef struct rc_conf rc_handle;
371371

372372
typedef struct dict_attr
373373
{
374-
char name[NAME_LENGTH + 1]; /* attribute name */
375-
int value; /* attribute index */
376-
int type; /* string, int, etc. */
374+
char name[NAME_LENGTH + 1]; //!< attribute name.
375+
int value; //!< attribute index.
376+
int type; //!< string, int, etc..
377377
struct dict_attr *next;
378378
} DICT_ATTR;
379379

@@ -415,15 +415,15 @@ typedef struct value_pair
415415

416416
typedef struct send_data /* Used to pass information to sendserver() function */
417417
{
418-
uint8_t code; /* RADIUS packet code */
419-
uint8_t seq_nbr; /* Packet sequence number */
420-
char *server; /* Name/addrress of RADIUS server */
421-
int svc_port; /* RADIUS protocol destination port */
422-
char *secret; /* Shared secret of RADIUS server */
423-
int timeout; /* Session timeout in seconds */
418+
uint8_t code; //!< RADIUS packet code.
419+
uint8_t seq_nbr; //!< Packet sequence number.
420+
char *server; //!< Name/addrress of RADIUS server.
421+
int svc_port; //!< RADIUS protocol destination port.
422+
char *secret; //!< Shared secret of RADIUS server.
423+
int timeout; //!< Session timeout in seconds.
424424
int retries;
425-
VALUE_PAIR *send_pairs; /* More a/v pairs to send */
426-
VALUE_PAIR *receive_pairs; /* Where to place received a/v pairs */
425+
VALUE_PAIR *send_pairs; //!< More a/v pairs to send.
426+
VALUE_PAIR *receive_pairs; //!< Where to place received a/v pairs.
427427
} SEND_DATA;
428428

429429
#ifndef MIN

‎include/pathnames.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@
1717
#ifndef PATHNAMES_H
1818
#define PATHNAMES_H
1919

20-
#define _PATH_DEV_URANDOM "/dev/urandom" /* Linux only */
21-
#define _PATH_ETC_ISSUE "/etc/issue"
20+
#define _PATH_DEV_URANDOM "/dev/urandom" /* Linux only */
21+
#define _PATH_ETC_ISSUE "/etc/issue"
2222

2323
/* normally defined in the Makefile */
2424
#ifndef _PATH_ETC_RADIUSCLIENT_CONF
25-
#define _PATH_ETC_RADIUSCLIENT_CONF "/etc/radiusclient.conf"
25+
# define _PATH_ETC_RADIUSCLIENT_CONF "/etc/radiusclient.conf"
2626
#endif
2727

2828
#endif /* PATHNAMES_H */

0 commit comments

Comments
 (0)