Utility library to read and write Ndef messages from/to a Type4 NFC tag
Dependents: NFC M2M_2016_STM32 MyongjiElec_capstone1 IDW01M1_Cloud_IBM ... more
Fork of NDefLib by
NDEF NFC library
This library provides an abstract API to create NDEF formatted messages and records and to read/write them from/to a Type4 NFC Tag.
Implementations
At the moment, the NDEF API is implemented by X_NUCLEO_NFC01A1 and X_NUCLEO_NFC02A1 Dynamic NFC Tag libraries respectively driving the X-NUCLEO-NFC01A1 and X-NUCLEO-NFC02A1 boards.
RecordType/RecordWifiConf.h@19:13d84b136a62, 2017-04-28 (annotated)
- Committer:
- giovannivisentini
- Date:
- Fri Apr 28 12:13:51 2017 +0000
- Revision:
- 19:13d84b136a62
- Parent:
- 18:cf1dd5c931c2
- Child:
- 20:31f727872290
Aligned to ARM mbed coding style.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
giovannivisentini | 18:cf1dd5c931c2 | 1 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 2 | ****************************************************************************** |
giovannivisentini | 18:cf1dd5c931c2 | 3 | * @file RecordWifiConf.h |
giovannivisentini | 18:cf1dd5c931c2 | 4 | * @author ST / Central Labs |
giovannivisentini | 19:13d84b136a62 | 5 | * @version V2.0.0 |
giovannivisentini | 19:13d84b136a62 | 6 | * @date 28 Apr 2017 |
giovannivisentini | 18:cf1dd5c931c2 | 7 | * @brief {@link RecordMimeType} that contains a Wifi configuration data |
giovannivisentini | 18:cf1dd5c931c2 | 8 | ****************************************************************************** |
giovannivisentini | 18:cf1dd5c931c2 | 9 | * @attention |
giovannivisentini | 18:cf1dd5c931c2 | 10 | * |
giovannivisentini | 18:cf1dd5c931c2 | 11 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
giovannivisentini | 18:cf1dd5c931c2 | 12 | * |
giovannivisentini | 18:cf1dd5c931c2 | 13 | * Redistribution and use in source and binary forms, with or without modification, |
giovannivisentini | 18:cf1dd5c931c2 | 14 | * are permitted provided that the following conditions are met: |
giovannivisentini | 18:cf1dd5c931c2 | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
giovannivisentini | 18:cf1dd5c931c2 | 16 | * this list of conditions and the following disclaimer. |
giovannivisentini | 18:cf1dd5c931c2 | 17 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
giovannivisentini | 18:cf1dd5c931c2 | 18 | * this list of conditions and the following disclaimer in the documentation |
giovannivisentini | 18:cf1dd5c931c2 | 19 | * and/or other materials provided with the distribution. |
giovannivisentini | 18:cf1dd5c931c2 | 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
giovannivisentini | 18:cf1dd5c931c2 | 21 | * may be used to endorse or promote products derived from this software |
giovannivisentini | 18:cf1dd5c931c2 | 22 | * without specific prior written permission. |
giovannivisentini | 18:cf1dd5c931c2 | 23 | * |
giovannivisentini | 18:cf1dd5c931c2 | 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
giovannivisentini | 18:cf1dd5c931c2 | 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
giovannivisentini | 18:cf1dd5c931c2 | 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
giovannivisentini | 18:cf1dd5c931c2 | 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
giovannivisentini | 18:cf1dd5c931c2 | 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
giovannivisentini | 18:cf1dd5c931c2 | 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
giovannivisentini | 18:cf1dd5c931c2 | 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
giovannivisentini | 18:cf1dd5c931c2 | 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
giovannivisentini | 18:cf1dd5c931c2 | 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
giovannivisentini | 18:cf1dd5c931c2 | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
giovannivisentini | 18:cf1dd5c931c2 | 34 | * |
giovannivisentini | 18:cf1dd5c931c2 | 35 | ****************************************************************************** |
giovannivisentini | 18:cf1dd5c931c2 | 36 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 37 | |
giovannivisentini | 18:cf1dd5c931c2 | 38 | #ifndef NDEFLIB_RECORDTYPE_RECORDWIFICONF_H_ |
giovannivisentini | 18:cf1dd5c931c2 | 39 | #define NDEFLIB_RECORDTYPE_RECORDWIFICONF_H_ |
giovannivisentini | 18:cf1dd5c931c2 | 40 | |
giovannivisentini | 18:cf1dd5c931c2 | 41 | #include <RecordMimeType.h> |
giovannivisentini | 18:cf1dd5c931c2 | 42 | namespace NDefLib { |
giovannivisentini | 18:cf1dd5c931c2 | 43 | |
giovannivisentini | 18:cf1dd5c931c2 | 44 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 45 | * Specialize the {@link RecordMimeType} to store Wifi configuration information. |
giovannivisentini | 18:cf1dd5c931c2 | 46 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 47 | class RecordWifiConf: public NDefLib::RecordMimeType { |
giovannivisentini | 18:cf1dd5c931c2 | 48 | public: |
giovannivisentini | 18:cf1dd5c931c2 | 49 | |
giovannivisentini | 18:cf1dd5c931c2 | 50 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 51 | * Authentication required by the wifi network |
giovannivisentini | 18:cf1dd5c931c2 | 52 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 53 | typedef enum { |
giovannivisentini | 18:cf1dd5c931c2 | 54 | AUTH_OPEN = 0x0000, //!< no authentication |
giovannivisentini | 18:cf1dd5c931c2 | 55 | AUTH_WPA_PSK = 0x0002, |
giovannivisentini | 18:cf1dd5c931c2 | 56 | AUTH_WPA_EAP = 0x0008, |
giovannivisentini | 18:cf1dd5c931c2 | 57 | AUTH_WPA2_EAP = 0x0010, |
giovannivisentini | 18:cf1dd5c931c2 | 58 | AUTH_WPA2_PSK = 0x0020, |
giovannivisentini | 18:cf1dd5c931c2 | 59 | }authType_t; |
giovannivisentini | 18:cf1dd5c931c2 | 60 | |
giovannivisentini | 18:cf1dd5c931c2 | 61 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 62 | * Encryption used by the network |
giovannivisentini | 18:cf1dd5c931c2 | 63 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 64 | typedef enum { |
giovannivisentini | 18:cf1dd5c931c2 | 65 | ENC_TYPE_NONE = 0x0001, //!< no authentication |
giovannivisentini | 18:cf1dd5c931c2 | 66 | ENC_TYPE_WEP = 0x0002, //!< wep is deprecated |
giovannivisentini | 18:cf1dd5c931c2 | 67 | ENC_TYPE_TKIP = 0x0004, //!< deprecated -> only with mixed mode (0x000c) |
giovannivisentini | 18:cf1dd5c931c2 | 68 | ENC_TYPE_AES = 0x0008, //!< includes CCMP and GCMP |
giovannivisentini | 18:cf1dd5c931c2 | 69 | ENC_TYPE_AES_TKIP = 0x000c, //!< mixed mode |
giovannivisentini | 18:cf1dd5c931c2 | 70 | }encryptionType_t; |
giovannivisentini | 18:cf1dd5c931c2 | 71 | |
giovannivisentini | 18:cf1dd5c931c2 | 72 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 73 | * Create a RecordWifiConf reading the data from the buffer. |
giovannivisentini | 18:cf1dd5c931c2 | 74 | * @param header Record header. |
giovannivisentini | 18:cf1dd5c931c2 | 75 | * @param buffer Buffer to read the data from. |
giovannivisentini | 18:cf1dd5c931c2 | 76 | * @return an object of type RecordVCard or NULL |
giovannivisentini | 18:cf1dd5c931c2 | 77 | * @par User is in charge of freeing the pointer returned by this function. |
giovannivisentini | 18:cf1dd5c931c2 | 78 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 79 | static RecordWifiConf* parse(const RecordHeader &header, |
giovannivisentini | 18:cf1dd5c931c2 | 80 | const uint8_t* buffer); |
giovannivisentini | 18:cf1dd5c931c2 | 81 | |
giovannivisentini | 18:cf1dd5c931c2 | 82 | |
giovannivisentini | 18:cf1dd5c931c2 | 83 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 84 | * Create a record with the wifi configuration, the default parameters create an open network |
giovannivisentini | 18:cf1dd5c931c2 | 85 | * @param ssid network name |
giovannivisentini | 18:cf1dd5c931c2 | 86 | * @param pass network password |
giovannivisentini | 18:cf1dd5c931c2 | 87 | * @param authType authentication used in the network |
giovannivisentini | 18:cf1dd5c931c2 | 88 | * @param encType encryption used in the network |
giovannivisentini | 18:cf1dd5c931c2 | 89 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 90 | RecordWifiConf(const std::string &ssid,const std::string &pass="", |
giovannivisentini | 18:cf1dd5c931c2 | 91 | authType_t authType=AUTH_OPEN,encryptionType_t encType=ENC_TYPE_NONE); |
giovannivisentini | 18:cf1dd5c931c2 | 92 | |
giovannivisentini | 18:cf1dd5c931c2 | 93 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 94 | * Get the record type. |
giovannivisentini | 18:cf1dd5c931c2 | 95 | * @return TYPE_WIFI_CONF |
giovannivisentini | 18:cf1dd5c931c2 | 96 | */ |
giovannivisentini | 19:13d84b136a62 | 97 | virtual RecordType_t get_type() const { |
giovannivisentini | 18:cf1dd5c931c2 | 98 | return TYPE_WIFI_CONF; |
giovannivisentini | 18:cf1dd5c931c2 | 99 | } //getType |
giovannivisentini | 18:cf1dd5c931c2 | 100 | |
giovannivisentini | 18:cf1dd5c931c2 | 101 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 102 | * @return update the record content and return the number of |
giovannivisentini | 18:cf1dd5c931c2 | 103 | * bytes needed to store this record |
giovannivisentini | 18:cf1dd5c931c2 | 104 | */ |
giovannivisentini | 19:13d84b136a62 | 105 | virtual uint16_t get_byte_length() { |
giovannivisentini | 19:13d84b136a62 | 106 | update_mime_data(); |
giovannivisentini | 19:13d84b136a62 | 107 | return RecordMimeType::get_byte_length(); |
giovannivisentini | 18:cf1dd5c931c2 | 108 | } |
giovannivisentini | 18:cf1dd5c931c2 | 109 | |
giovannivisentini | 18:cf1dd5c931c2 | 110 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 111 | * Update the content and write it on the buffer. |
giovannivisentini | 18:cf1dd5c931c2 | 112 | * @param[out] buffer buffer to write the record content into. |
giovannivisentini | 18:cf1dd5c931c2 | 113 | * @return number of bytes written |
giovannivisentini | 18:cf1dd5c931c2 | 114 | * @see Record#write |
giovannivisentini | 18:cf1dd5c931c2 | 115 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 116 | virtual uint16_t write(uint8_t *buffer){ |
giovannivisentini | 19:13d84b136a62 | 117 | update_mime_data(); |
giovannivisentini | 18:cf1dd5c931c2 | 118 | return RecordMimeType::write(buffer); |
giovannivisentini | 18:cf1dd5c931c2 | 119 | } |
giovannivisentini | 18:cf1dd5c931c2 | 120 | |
giovannivisentini | 18:cf1dd5c931c2 | 121 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 122 | * Compare two objects. |
giovannivisentini | 18:cf1dd5c931c2 | 123 | * @return true if the records have the same Vcard information |
giovannivisentini | 18:cf1dd5c931c2 | 124 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 125 | bool operator==(const RecordWifiConf &other){ |
giovannivisentini | 18:cf1dd5c931c2 | 126 | return (mSsid==other.mSsid) && |
giovannivisentini | 18:cf1dd5c931c2 | 127 | (mPasskey==other.mPasskey) && |
giovannivisentini | 18:cf1dd5c931c2 | 128 | (mAuthType==other.mAuthType) && |
giovannivisentini | 18:cf1dd5c931c2 | 129 | (mEncType==other.mEncType); |
giovannivisentini | 18:cf1dd5c931c2 | 130 | } |
giovannivisentini | 18:cf1dd5c931c2 | 131 | |
giovannivisentini | 18:cf1dd5c931c2 | 132 | |
giovannivisentini | 19:13d84b136a62 | 133 | const std::string& get_network_key() const{ |
giovannivisentini | 18:cf1dd5c931c2 | 134 | return mPasskey; |
giovannivisentini | 18:cf1dd5c931c2 | 135 | } |
giovannivisentini | 18:cf1dd5c931c2 | 136 | |
giovannivisentini | 19:13d84b136a62 | 137 | void set_network_key(const std::string &newKey){ |
giovannivisentini | 18:cf1dd5c931c2 | 138 | mPasskey=newKey; |
giovannivisentini | 18:cf1dd5c931c2 | 139 | mContentIsChange=true; |
giovannivisentini | 18:cf1dd5c931c2 | 140 | } |
giovannivisentini | 18:cf1dd5c931c2 | 141 | |
giovannivisentini | 19:13d84b136a62 | 142 | const std::string& get_network_ssid() const{ |
giovannivisentini | 18:cf1dd5c931c2 | 143 | return mSsid; |
giovannivisentini | 18:cf1dd5c931c2 | 144 | } |
giovannivisentini | 18:cf1dd5c931c2 | 145 | |
giovannivisentini | 19:13d84b136a62 | 146 | void set_network_ssid(const std::string &newSsid){ |
giovannivisentini | 18:cf1dd5c931c2 | 147 | mSsid=newSsid; |
giovannivisentini | 18:cf1dd5c931c2 | 148 | mContentIsChange=true; |
giovannivisentini | 18:cf1dd5c931c2 | 149 | } |
giovannivisentini | 18:cf1dd5c931c2 | 150 | |
giovannivisentini | 19:13d84b136a62 | 151 | authType_t get_auth_type() const{ |
giovannivisentini | 18:cf1dd5c931c2 | 152 | return mAuthType; |
giovannivisentini | 18:cf1dd5c931c2 | 153 | } |
giovannivisentini | 18:cf1dd5c931c2 | 154 | |
giovannivisentini | 19:13d84b136a62 | 155 | void set_auth_type(const authType_t &newAuth){ |
giovannivisentini | 18:cf1dd5c931c2 | 156 | mAuthType = newAuth; |
giovannivisentini | 18:cf1dd5c931c2 | 157 | mContentIsChange=true; |
giovannivisentini | 18:cf1dd5c931c2 | 158 | } |
giovannivisentini | 18:cf1dd5c931c2 | 159 | |
giovannivisentini | 19:13d84b136a62 | 160 | encryptionType_t get_encryption() const{ |
giovannivisentini | 18:cf1dd5c931c2 | 161 | return mEncType; |
giovannivisentini | 18:cf1dd5c931c2 | 162 | } |
giovannivisentini | 18:cf1dd5c931c2 | 163 | |
giovannivisentini | 19:13d84b136a62 | 164 | void set_encryption_type(const encryptionType_t &newEncript){ |
giovannivisentini | 18:cf1dd5c931c2 | 165 | mEncType = newEncript; |
giovannivisentini | 18:cf1dd5c931c2 | 166 | mContentIsChange=true; |
giovannivisentini | 18:cf1dd5c931c2 | 167 | } |
giovannivisentini | 18:cf1dd5c931c2 | 168 | |
giovannivisentini | 18:cf1dd5c931c2 | 169 | virtual ~RecordWifiConf(){ |
giovannivisentini | 18:cf1dd5c931c2 | 170 | if(mMimeData!=NULL) |
giovannivisentini | 18:cf1dd5c931c2 | 171 | delete [] mMimeData; |
giovannivisentini | 18:cf1dd5c931c2 | 172 | } |
giovannivisentini | 18:cf1dd5c931c2 | 173 | |
giovannivisentini | 18:cf1dd5c931c2 | 174 | private: |
giovannivisentini | 18:cf1dd5c931c2 | 175 | |
giovannivisentini | 18:cf1dd5c931c2 | 176 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 177 | * function that update the ndef data format |
giovannivisentini | 18:cf1dd5c931c2 | 178 | */ |
giovannivisentini | 19:13d84b136a62 | 179 | void update_mime_data(); |
giovannivisentini | 18:cf1dd5c931c2 | 180 | |
giovannivisentini | 18:cf1dd5c931c2 | 181 | typedef uint16_t fieldType_t; //< type to use for store a field type |
giovannivisentini | 19:13d84b136a62 | 182 | typedef uint16_t fieldLenght_t; //<type to use for store a filed length |
giovannivisentini | 18:cf1dd5c931c2 | 183 | |
giovannivisentini | 18:cf1dd5c931c2 | 184 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 185 | * write a data field into the output buffer |
giovannivisentini | 18:cf1dd5c931c2 | 186 | * @param dataType field type |
giovannivisentini | 18:cf1dd5c931c2 | 187 | * @param data field content |
giovannivisentini | 18:cf1dd5c931c2 | 188 | * @param buffer buffer where write the data field |
giovannivisentini | 18:cf1dd5c931c2 | 189 | * @return number of write bytes |
giovannivisentini | 18:cf1dd5c931c2 | 190 | */ |
giovannivisentini | 18:cf1dd5c931c2 | 191 | template<typename T> |
giovannivisentini | 19:13d84b136a62 | 192 | uint32_t write_data_field(const fieldType_t& dataType, |
giovannivisentini | 18:cf1dd5c931c2 | 193 | const T& data, uint8_t *buffer); |
giovannivisentini | 18:cf1dd5c931c2 | 194 | |
giovannivisentini | 18:cf1dd5c931c2 | 195 | /** |
giovannivisentini | 18:cf1dd5c931c2 | 196 | * write a data buffer inside the output buffer |
giovannivisentini | 18:cf1dd5c931c2 | 197 | * @param dataType field type |
giovannivisentini | 18:cf1dd5c931c2 | 198 | * @param data buffer where read the data |
giovannivisentini | 18:cf1dd5c931c2 | 199 | * @param size number of byte to move |
giovannivisentini | 18:cf1dd5c931c2 | 200 | * @param out output buffer |
giovannivisentini | 18:cf1dd5c931c2 | 201 | * @return number of write bytes |
giovannivisentini | 18:cf1dd5c931c2 | 202 | */ |
giovannivisentini | 19:13d84b136a62 | 203 | uint32_t write_data_field(const fieldType_t& dataType, |
giovannivisentini | 18:cf1dd5c931c2 | 204 | const char *data,const fieldLenght_t& size, uint8_t *buffer); |
giovannivisentini | 18:cf1dd5c931c2 | 205 | |
giovannivisentini | 18:cf1dd5c931c2 | 206 | std::string mSsid; |
giovannivisentini | 18:cf1dd5c931c2 | 207 | std::string mPasskey; |
giovannivisentini | 18:cf1dd5c931c2 | 208 | authType_t mAuthType; |
giovannivisentini | 18:cf1dd5c931c2 | 209 | encryptionType_t mEncType; |
giovannivisentini | 18:cf1dd5c931c2 | 210 | |
giovannivisentini | 18:cf1dd5c931c2 | 211 | bool mContentIsChange; ///< true if we have to update the string representation of the data |
giovannivisentini | 18:cf1dd5c931c2 | 212 | uint8_t *mMimeData; //< buffer where store the record playload |
giovannivisentini | 18:cf1dd5c931c2 | 213 | fieldLenght_t mMimeDataLenght; |
giovannivisentini | 18:cf1dd5c931c2 | 214 | |
giovannivisentini | 18:cf1dd5c931c2 | 215 | |
giovannivisentini | 18:cf1dd5c931c2 | 216 | static const std::string sWifiConfMimeType; |
giovannivisentini | 18:cf1dd5c931c2 | 217 | static const fieldType_t sCredentialField_id; |
giovannivisentini | 18:cf1dd5c931c2 | 218 | static const fieldType_t sNetworkIdField_id; |
giovannivisentini | 18:cf1dd5c931c2 | 219 | static const uint8_t sDefaultNetworkId; |
giovannivisentini | 18:cf1dd5c931c2 | 220 | static const fieldType_t sSsidField_id; |
giovannivisentini | 18:cf1dd5c931c2 | 221 | static const fieldType_t sNetworkKeyField_id; |
giovannivisentini | 18:cf1dd5c931c2 | 222 | static const fieldType_t sAuthTypeField_id; |
giovannivisentini | 18:cf1dd5c931c2 | 223 | static const fieldType_t sEncTypeField_id; |
giovannivisentini | 18:cf1dd5c931c2 | 224 | }; |
giovannivisentini | 18:cf1dd5c931c2 | 225 | } |
giovannivisentini | 18:cf1dd5c931c2 | 226 | |
giovannivisentini | 18:cf1dd5c931c2 | 227 | #endif /* NDEFLIB_RECORDTYPE_RECORDWIFICONF_H_ */ |
giovannivisentini | 18:cf1dd5c931c2 | 228 |