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_MAX];
19 	size_t pmk_len;
20 	os_time_t expiration;
21 	int akmp; /* WPA_KEY_MGMT_* */
22 	u8 aa[ETH_ALEN];
23 
24 	/*
25 	 * If FILS Cache Identifier is included (fils_cache_id_set), this PMKSA
26 	 * cache entry is applicable to all BSSs (any BSSID/aa[]) that
27 	 * advertise the same FILS Cache Identifier within the same ESS.
28 	 */
29 	u8 fils_cache_id[2];
30 	unsigned int fils_cache_id_set:1;
31 
32 	os_time_t reauth_time;
33 
34 	/**
35 	 * network_ctx - Network configuration context
36 	 *
37 	 * This field is only used to match PMKSA cache entries to a specific
38 	 * network configuration (e.g., a specific SSID and security policy).
39 	 * This can be a pointer to the configuration entry, but PMKSA caching
40 	 * code does not dereference the value and this could be any kind of
41 	 * identifier.
42 	 */
43 	void *network_ctx;
44 	int opportunistic;
45 };
46 
47 struct rsn_pmksa_cache;
48 
49 enum pmksa_free_reason {
50 	PMKSA_FREE,
51 	PMKSA_REPLACE,
52 	PMKSA_EXPIRE,
53 };
54 
55 #if defined(IEEE8021X_EAPOL) && !defined(CONFIG_NO_WPA)
56 
57 struct rsn_pmksa_cache *
58 pmksa_cache_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
59 				 void *ctx, enum pmksa_free_reason reason),
60 		 void *ctx, struct wpa_sm *sm);
61 void pmksa_cache_deinit(struct rsn_pmksa_cache *pmksa);
62 struct rsn_pmksa_cache_entry * pmksa_cache_get(struct rsn_pmksa_cache *pmksa,
63 					       const u8 *aa, const u8 *pmkid,
64 					       const void *network_ctx,
65 					       int akmp);
66 int pmksa_cache_list(struct rsn_pmksa_cache *pmksa, char *buf, size_t len);
67 struct rsn_pmksa_cache_entry * pmksa_cache_head(struct rsn_pmksa_cache *pmksa);
68 struct rsn_pmksa_cache_entry *
69 pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
70 		const u8 *pmkid, const u8 *kck, size_t kck_len,
71 		const u8 *aa, const u8 *spa, void *network_ctx, int akmp,
72 		const u8 *cache_id);
73 struct rsn_pmksa_cache_entry *
74 pmksa_cache_add_entry(struct rsn_pmksa_cache *pmksa,
75 		      struct rsn_pmksa_cache_entry *entry);
76 struct rsn_pmksa_cache_entry * pmksa_cache_get_current(struct wpa_sm *sm);
77 void pmksa_cache_clear_current(struct wpa_sm *sm);
78 int pmksa_cache_set_current(struct wpa_sm *sm, const u8 *pmkid,
79 			    const u8 *bssid, void *network_ctx,
80 			    int try_opportunistic, const u8 *fils_cache_id,
81 			    int akmp);
82 struct rsn_pmksa_cache_entry *
83 pmksa_cache_get_opportunistic(struct rsn_pmksa_cache *pmksa,
84 			      void *network_ctx, const u8 *aa, int akmp);
85 void pmksa_cache_flush(struct rsn_pmksa_cache *pmksa, void *network_ctx,
86 		       const u8 *pmk, size_t pmk_len);
87 
88 #else /* IEEE8021X_EAPOL */
89 
90 static inline struct rsn_pmksa_cache *
91 pmksa_cache_init(void (*free_cb)(struct rsn_pmksa_cache_entry *entry,
92 				 void *ctx, enum pmksa_free_reason reason),
93 		 void *ctx, struct wpa_sm *sm)
94 {
95 	return (void *) -1;
96 }
97 
98 static inline void pmksa_cache_deinit(struct rsn_pmksa_cache *pmksa)
99 {
100 }
101 
102 static inline struct rsn_pmksa_cache_entry *
103 pmksa_cache_get(struct rsn_pmksa_cache *pmksa, const u8 *aa, const u8 *pmkid,
104 		const void *network_ctx, int akmp)
105 {
106 	return NULL;
107 }
108 
109 static inline struct rsn_pmksa_cache_entry *
110 pmksa_cache_get_current(struct wpa_sm *sm)
111 {
112 	return NULL;
113 }
114 
115 static inline int pmksa_cache_list(struct rsn_pmksa_cache *pmksa, char *buf,
116 				   size_t len)
117 {
118 	return -1;
119 }
120 
121 static inline struct rsn_pmksa_cache_entry *
122 pmksa_cache_head(struct rsn_pmksa_cache *pmksa)
123 {
124 	return NULL;
125 }
126 
127 static inline struct rsn_pmksa_cache_entry *
128 pmksa_cache_add_entry(struct rsn_pmksa_cache *pmksa,
129 		      struct rsn_pmksa_cache_entry *entry)
130 {
131 	return NULL;
132 }
133 
134 static inline struct rsn_pmksa_cache_entry *
135 pmksa_cache_add(struct rsn_pmksa_cache *pmksa, const u8 *pmk, size_t pmk_len,
136 		const u8 *pmkid, const u8 *kck, size_t kck_len,
137 		const u8 *aa, const u8 *spa, void *network_ctx, int akmp,
138 		const u8 *cache_id)
139 {
140 	return NULL;
141 }
142 
143 static inline void pmksa_cache_clear_current(struct wpa_sm *sm)
144 {
145 }
146 
147 static inline int pmksa_cache_set_current(struct wpa_sm *sm, const u8 *pmkid,
148 					  const u8 *bssid,
149 					  void *network_ctx,
150 					  int try_opportunistic,
151 					  const u8 *fils_cache_id,
152 					  int akmp)
153 {
154 	return -1;
155 }
156 
157 static inline void pmksa_cache_flush(struct rsn_pmksa_cache *pmksa,
158 				     void *network_ctx,
159 				     const u8 *pmk, size_t pmk_len)
160 {
161 }
162 
163 #endif /* IEEE8021X_EAPOL */
164 
165 #endif /* PMKSA_CACHE_H */
166