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