diff --git a/cmake/appveyor.yml b/cmake/appveyor.yml index 6b66ca1..cc7c560 100644 --- a/cmake/appveyor.yml +++ b/cmake/appveyor.yml @@ -39,4 +39,6 @@ test_script: - cd c:\projects\libtins\build - ctest -C %Configuration% deploy_script: -- ps: Push-AppveyorArtifact "install\libtins-$env:Platform-$env:Configuration.zip" \ No newline at end of file +- ps: Push-AppveyorArtifact "install\libtins-$env:Platform-$env:Configuration.zip" +skip_commits: + message: /Update documentation.*/ diff --git a/include/tins/crypto.h b/include/tins/crypto.h index 6e7dfce..7014059 100644 --- a/include/tins/crypto.h +++ b/include/tins/crypto.h @@ -130,24 +130,36 @@ namespace Crypto { }; /** - * \cond - */ + * \brief Represents a WPA2 supplicant's data. + * + * Objects of this class can be given the pre-shared key and the SSID + * of some access point, and this will generate the Pairwise Master Key + * from those parameters. + */ class SupplicantData { public: - typedef HWAddress<6> address_type; + /** + * The type used to store the PMK. + */ typedef SessionKeys::pmk_type pmk_type; + /** + * \brief Constructs a SupplicantData. + * \param psk The pre-shared key. + * \param ssid The access point's SSID. + */ SupplicantData(const std::string &psk, const std::string &ssid); + /** + * \brief Getter for the PMK. + * \return The generated PMK. + */ const pmk_type &pmk() const; private: pmk_type pmk_; }; } // WPA2 #endif // HAVE_WPA2_DECRYPTION - /** - * \endcond - */ /** * \brief RC4 Key abstraction.