1 /*
2  * wpa_supplicant - WPA2/RSN PMKSA cache functions
3  * Copyright (c) 2003-2009, 2011-2012, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #ifndef PMKSA_CACHE_H
10 #define PMKSA_CACHE_H
11 
12 /**
13  * struct rsn_pmksa_cache_entry - PMKSA cache entry
14  */
15 struct rsn_pmksa_cache_entry {
16 	struct rsn_pmksa_cache_entry *next;
17 	u8 pmkid[PMKID_LEN];
18 	u8 pmk[PMK_LEN];
19 	size_t pmk_len;
20 	os_time_t expiration;
21 	int akmp; /* WPA_KEY_MGMT_* */
22 	u8 aa[ETH_ALEN];
23 
24 	os_time_t reauth_time;
25 
26 	/**
27 	 * network_ctx - Network configuration context
28 	 *
29 	 * This field is only used to match PMKSA cache entries to a specific
30 	 * network configuration (e.g., a specific SSID and security policy).
31 	 * This can be a pointer to the configuration entry, but PMKSA caching
32 	 * code does not dereference the value and this could be any kind of
33 	 * identifier.
34 	 */
35 	void *network_ctx;
36 	int opportunistic;
37 };
38 
39 struct rsn_pmksa_cache;
40 
41 enum pmksa_free_reason {
42 	PMKSA_FREE,
43 	PMKSA_REPLACE,
44 	PMKSA_EXPIRE,
45 };
46 
47 #ifdef IEEE8021X_EAPOL
48 
49 struct rsn_pmksa_cache *
50 pmksa_cache_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
51 				 void *ctx, enum pmksa_free_reason reason),
52 		 void *ctx, struct wpa_sm *sm);
53 void pmksa_cache_deinit(struct rsn_pmksa_cache *pmksa);
54 struct rsn_pmksa_cache_entry * pmksa_cache_get(struct rsn_pmksa_cache *pmksa,
55 					       const u8 *aa, const u8 *pmkid,
56 					       const void *network_ctx);
57 int pmksa_cache_list(struct rsn_pmksa_cache *pmksa, char *buf, size_t len);
58 struct rsn_pmksa_cache_entry *
59 pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
60 		const u8 *aa, const u8 *spa, void *network_ctx, int akmp);
61 struct rsn_pmksa_cache_entry * pmksa_cache_get_current(struct wpa_sm *sm);
62 void pmksa_cache_clear_current(struct wpa_sm *sm);
63 int pmksa_cache_set_current(struct wpa_sm *sm, const u8 *pmkid,
64 			    const u8 *bssid, void *network_ctx,
65 			    int try_opportunistic);
66 struct rsn_pmksa_cache_entry *
67 pmksa_cache_get_opportunistic(struct rsn_pmksa_cache *pmksa,
68 			      void *network_ctx, const u8 *aa);
69 void pmksa_cache_flush(struct rsn_pmksa_cache *pmksa, void *network_ctx,
70 		       const u8 *pmk, size_t pmk_len);
71 
72 #else /* IEEE8021X_EAPOL */
73 
74 static inline struct rsn_pmksa_cache *
75 pmksa_cache_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
76 				 void *ctx, enum pmksa_free_reason reason),
77 		 void *ctx, struct wpa_sm *sm)
78 {
79 	return (void *) -1;
80 }
81 
82 static inline void pmksa_cache_deinit(struct rsn_pmksa_cache *pmksa)
83 {
84 }
85 
86 static inline struct rsn_pmksa_cache_entry *
87 pmksa_cache_get(struct rsn_pmksa_cache *pmksa, const u8 *aa, const u8 *pmkid,
88 		const void *network_ctx)
89 {
90 	return NULL;
91 }
92 
93 static inline struct rsn_pmksa_cache_entry *
94 pmksa_cache_get_current(struct wpa_sm *sm)
95 {
96 	return NULL;
97 }
98 
99 static inline int pmksa_cache_list(struct rsn_pmksa_cache *pmksa, char *buf,
100 				   size_t len)
101 {
102 	return -1;
103 }
104 
105 static inline struct rsn_pmksa_cache_entry *
106 pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
107 		const u8 *aa, const u8 *spa, void *network_ctx, int akmp)
108 {
109 	return NULL;
110 }
111 
112 static inline void pmksa_cache_clear_current(struct wpa_sm *sm)
113 {
114 }
115 
116 static inline int pmksa_cache_set_current(struct wpa_sm *sm, const u8 *pmkid,
117 					  const u8 *bssid,
118 					  void *network_ctx,
119 					  int try_opportunistic)
120 {
121 	return -1;
122 }
123 
124 static inline void pmksa_cache_flush(struct rsn_pmksa_cache *pmksa,
125 				     void *network_ctx,
126 				     const u8 *pmk, size_t pmk_len)
127 {
128 }
129 
130 #endif /* IEEE8021X_EAPOL */
131 
132 #endif /* PMKSA_CACHE_H */
133