Ref T730, CPP check issues fixed

This commit is contained in:
Klaus Basan
2019-10-11 15:05:11 +02:00
committed by Mat Sutcliffe
parent 1d9cd50463
commit 30baa12a86
11 changed files with 221 additions and 222 deletions

View File

@@ -10,154 +10,156 @@
QJsonWebToken::QJsonWebToken()
{
// create the header with default algorithm
setAlgorithmStr("HS256");
m_jdocPayload = QJsonDocument::fromJson("{}");
// create the header with default algorithm
setAlgorithmStr("HS256");
m_jdocPayload = QJsonDocument::fromJson("{}");
// default for random generation
m_intRandLength = 10;
m_strRandAlphanum = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
}
QJsonWebToken::QJsonWebToken(const QJsonWebToken &other)
QJsonWebToken::QJsonWebToken(const QJsonWebToken &other) :
m_jdocHeader(other.m_jdocHeader),
m_jdocPayload(other.m_jdocPayload),
m_byteSignature(other.m_byteSignature),
m_strSecret(other.m_strSecret),
m_strAlgorithm(other.m_strAlgorithm)
{
this->m_jdocHeader = other.m_jdocHeader;
this->m_jdocPayload = other.m_jdocPayload;
this->m_byteSignature = other.m_byteSignature;
this->m_strSecret = other.m_strSecret;
this->m_strAlgorithm = other.m_strAlgorithm;
// void
}
QJsonDocument QJsonWebToken::getHeaderJDoc() const
{
return m_jdocHeader;
return m_jdocHeader;
}
QString QJsonWebToken::getHeaderQStr(const QJsonDocument::JsonFormat &format/* = QJsonDocument::JsonFormat::Indented*/) const
{
return m_jdocHeader.toJson(format);
return m_jdocHeader.toJson(format);
}
bool QJsonWebToken::setHeaderJDoc(const QJsonDocument &jdocHeader)
{
if (jdocHeader.isEmpty() || jdocHeader.isNull() || !jdocHeader.isObject())
{
return false;
}
if (jdocHeader.isEmpty() || jdocHeader.isNull() || !jdocHeader.isObject())
{
return false;
}
// check if supported algorithm
QString strAlgorithm = jdocHeader.object().value("alg").toString("");
if (!isAlgorithmSupported(strAlgorithm))
{
return false;
}
// check if supported algorithm
const QString strAlgorithm = jdocHeader.object().value("alg").toString("");
if (!isAlgorithmSupported(strAlgorithm))
{
return false;
}
m_jdocHeader = jdocHeader;
m_jdocHeader = jdocHeader;
// set also new algorithm
m_strAlgorithm = strAlgorithm;
// set also new algorithm
m_strAlgorithm = strAlgorithm;
return true;
return true;
}
bool QJsonWebToken::setHeaderQStr(const QString &strHeader)
{
QJsonParseError error;
QJsonDocument tmpHeader = QJsonDocument::fromJson(strHeader.toUtf8(), &error);
QJsonParseError error;
QJsonDocument tmpHeader = QJsonDocument::fromJson(strHeader.toUtf8(), &error);
// validate and set header
if (error.error != QJsonParseError::NoError || !setHeaderJDoc(tmpHeader))
{
return false;
}
// validate and set header
if (error.error != QJsonParseError::NoError || !setHeaderJDoc(tmpHeader))
{
return false;
}
return true;
return true;
}
QJsonDocument QJsonWebToken::getPayloadJDoc() const
{
return m_jdocPayload;
return m_jdocPayload;
}
QString QJsonWebToken::getPayloadQStr(const QJsonDocument::JsonFormat &format/* = QJsonDocument::JsonFormat::Indented*/) const
{
return m_jdocPayload.toJson(format);
return m_jdocPayload.toJson(format);
}
bool QJsonWebToken::setPayloadJDoc(const QJsonDocument &jdocPayload)
{
if (jdocPayload.isEmpty() || jdocPayload.isNull() || !jdocPayload.isObject())
{
return false;
}
if (jdocPayload.isEmpty() || jdocPayload.isNull() || !jdocPayload.isObject())
{
return false;
}
m_jdocPayload = jdocPayload;
m_jdocPayload = jdocPayload;
return true;
return true;
}
bool QJsonWebToken::setPayloadQStr(const QString &strPayload)
{
QJsonParseError error;
QJsonDocument tmpPayload = QJsonDocument::fromJson(strPayload.toUtf8(), &error);
QJsonParseError error;
QJsonDocument tmpPayload = QJsonDocument::fromJson(strPayload.toUtf8(), &error);
// validate and set payload
if (error.error != QJsonParseError::NoError || !setPayloadJDoc(tmpPayload))
{
return false;
}
// validate and set payload
if (error.error != QJsonParseError::NoError || !setPayloadJDoc(tmpPayload))
{
return false;
}
return true;
return true;
}
QByteArray QJsonWebToken::getSignature()
{
// recalculate
// get header in compact mode and base64 encoded
QByteArray byteHeaderBase64 = getHeaderQStr(QJsonDocument::JsonFormat::Compact).toUtf8().toBase64();
// get payload in compact mode and base64 encoded
QByteArray bytePayloadBase64 = getPayloadQStr(QJsonDocument::JsonFormat::Compact).toUtf8().toBase64();
// calculate signature based on chosen algorithm and secret
m_byteAllData = byteHeaderBase64 + "." + bytePayloadBase64;
if (m_strAlgorithm.compare("HS256", Qt::CaseSensitive) == 0) // HMAC using SHA-256 hash algorithm
{
m_byteSignature = QMessageAuthenticationCode::hash(m_byteAllData, m_strSecret.toUtf8(), QCryptographicHash::Sha256);
}
else if (m_strAlgorithm.compare("HS384", Qt::CaseSensitive) == 0) // HMAC using SHA-384 hash algorithm
{
m_byteSignature = QMessageAuthenticationCode::hash(m_byteAllData, m_strSecret.toUtf8(), QCryptographicHash::Sha384);
}
else if (m_strAlgorithm.compare("HS512", Qt::CaseSensitive) == 0) // HMAC using SHA-512 hash algorithm
{
m_byteSignature = QMessageAuthenticationCode::hash(m_byteAllData, m_strSecret.toUtf8(), QCryptographicHash::Sha512);
}
// TODO : support other algorithms
else
{
m_byteSignature = QByteArray();
}
// return recalculated
return m_byteSignature;
// recalculate
// get header in compact mode and base64 encoded
QByteArray byteHeaderBase64 = getHeaderQStr(QJsonDocument::JsonFormat::Compact).toUtf8().toBase64();
// get payload in compact mode and base64 encoded
QByteArray bytePayloadBase64 = getPayloadQStr(QJsonDocument::JsonFormat::Compact).toUtf8().toBase64();
// calculate signature based on chosen algorithm and secret
m_byteAllData = byteHeaderBase64 + "." + bytePayloadBase64;
if (m_strAlgorithm.compare("HS256", Qt::CaseSensitive) == 0) // HMAC using SHA-256 hash algorithm
{
m_byteSignature = QMessageAuthenticationCode::hash(m_byteAllData, m_strSecret.toUtf8(), QCryptographicHash::Sha256);
}
else if (m_strAlgorithm.compare("HS384", Qt::CaseSensitive) == 0) // HMAC using SHA-384 hash algorithm
{
m_byteSignature = QMessageAuthenticationCode::hash(m_byteAllData, m_strSecret.toUtf8(), QCryptographicHash::Sha384);
}
else if (m_strAlgorithm.compare("HS512", Qt::CaseSensitive) == 0) // HMAC using SHA-512 hash algorithm
{
m_byteSignature = QMessageAuthenticationCode::hash(m_byteAllData, m_strSecret.toUtf8(), QCryptographicHash::Sha512);
}
// TODO : support other algorithms
else
{
m_byteSignature = QByteArray();
}
// return recalculated
return m_byteSignature;
}
QByteArray QJsonWebToken::getSignatureBase64()
{
// note we return through getSignature() to force recalculation
return getSignature().toBase64();
// note we return through getSignature() to force recalculation
return getSignature().toBase64();
}
QString QJsonWebToken::getSecret() const
{
return m_strSecret;
return m_strSecret;
}
bool QJsonWebToken::setSecret(const QString &strSecret)
{
if (strSecret.isEmpty() || strSecret.isNull())
{
return false;
}
if (strSecret.isEmpty() || strSecret.isNull())
{
return false;
}
m_strSecret = strSecret;
m_strSecret = strSecret;
return true;
}
@@ -173,75 +175,76 @@ void QJsonWebToken::setRandomSecret()
QString QJsonWebToken::getAlgorithmStr() const
{
return m_strAlgorithm;
return m_strAlgorithm;
}
bool QJsonWebToken::setAlgorithmStr(const QString &strAlgorithm)
{
// check if supported algorithm
if (!isAlgorithmSupported(strAlgorithm))
{
return false;
}
// set algorithm
m_strAlgorithm = strAlgorithm;
// modify header
m_jdocHeader = QJsonDocument::fromJson(QObject::trUtf8("{\"typ\": \"JWT\", \"alg\" : \"").toUtf8()
+ m_strAlgorithm.toUtf8()
+ QObject::trUtf8("\"}").toUtf8());
// check if supported algorithm
if (!isAlgorithmSupported(strAlgorithm))
{
return false;
}
// set algorithm
m_strAlgorithm = strAlgorithm;
// modify header
m_jdocHeader = QJsonDocument::fromJson(QObject::trUtf8("{\"typ\": \"JWT\", \"alg\" : \"").toUtf8()
+ m_strAlgorithm.toUtf8()
+ QObject::trUtf8("\"}").toUtf8());
return true;
return true;
}
QString QJsonWebToken::getToken()
{
// important to execute first to update m_byteAllData which contains header + "." + payload in base64
QByteArray byteSignatureBase64 = this->getSignatureBase64();
// compose token and return it
return m_byteAllData + "." + byteSignatureBase64;
// important to execute first to update m_byteAllData which contains header + "." + payload in base64
QByteArray byteSignatureBase64 = this->getSignatureBase64();
// compose token and return it
return m_byteAllData + "." + byteSignatureBase64;
}
bool QJsonWebToken::setToken(const QString &strToken)
{
// assume base64 encoded at first, if not try decoding
bool isBase64Encoded = true;
QStringList listJwtParts = strToken.split(".");
// check correct size
if (listJwtParts.count() != 3)
{
return false;
}
// check all parts are valid using another instance,
// so we dont overwrite this instance in case of error
QJsonWebToken tempTokenObj;
if ( !tempTokenObj.setHeaderQStr(QByteArray::fromBase64(listJwtParts.at(0).toUtf8())) ||
!tempTokenObj.setPayloadQStr(QByteArray::fromBase64(listJwtParts.at(1).toUtf8())) )
{
// try unencoded
if (!tempTokenObj.setHeaderQStr(listJwtParts.at(0)) ||
!tempTokenObj.setPayloadQStr(listJwtParts.at(1)))
{
return false;
}
else
{
isBase64Encoded = false;
}
}
// set parts on this instance
setHeaderQStr(tempTokenObj.getHeaderQStr());
setPayloadQStr(tempTokenObj.getPayloadQStr());
if (isBase64Encoded)
{ // unencode
m_byteSignature = QByteArray::fromBase64(listJwtParts.at(2).toUtf8());
}
else
{
m_byteSignature = listJwtParts.at(2).toUtf8();
}
// allData not valid anymore
m_byteAllData.clear();
// success
// assume base64 encoded at first, if not try decoding
bool isBase64Encoded = true;
QStringList listJwtParts = strToken.split(".");
// check correct size
if (listJwtParts.count() != 3)
{
return false;
}
// check all parts are valid using another instance,
// so we dont overwrite this instance in case of error
QJsonWebToken tempTokenObj;
if (!tempTokenObj.setHeaderQStr(QByteArray::fromBase64(listJwtParts.at(0).toUtf8())) ||
!tempTokenObj.setPayloadQStr(QByteArray::fromBase64(listJwtParts.at(1).toUtf8())))
{
// try unencoded
if (!tempTokenObj.setHeaderQStr(listJwtParts.at(0)) ||
!tempTokenObj.setPayloadQStr(listJwtParts.at(1)))
{
return false;
}
else
{
isBase64Encoded = false;
}
}
// set parts on this instance
setHeaderQStr(tempTokenObj.getHeaderQStr());
setPayloadQStr(tempTokenObj.getPayloadQStr());
if (isBase64Encoded)
{
// unencode
m_byteSignature = QByteArray::fromBase64(listJwtParts.at(2).toUtf8());
}
else
{
m_byteSignature = listJwtParts.at(2).toUtf8();
}
// allData not valid anymore
m_byteAllData.clear();
// success
return true;
}
@@ -252,7 +255,7 @@ QString QJsonWebToken::getRandAlphanum() const
void QJsonWebToken::setRandAlphanum(const QString &strRandAlphanum)
{
if(strRandAlphanum.isNull())
if (strRandAlphanum.isNull())
{
return;
}
@@ -264,9 +267,9 @@ int QJsonWebToken::getRandLength() const
return m_intRandLength;
}
void QJsonWebToken::setRandLength(const int &intRandLength)
void QJsonWebToken::setRandLength(int intRandLength)
{
if(intRandLength < 0 || intRandLength > 1e6)
if (intRandLength < 0 || intRandLength > 1e6)
{
return;
}
@@ -275,63 +278,63 @@ void QJsonWebToken::setRandLength(const int &intRandLength)
bool QJsonWebToken::isValid() const
{
// calculate token on other instance,
// so we dont overwrite this instance's signature
QJsonWebToken tempTokenObj = *this;
if (m_byteSignature != tempTokenObj.getSignature())
{
return false;
}
return true;
// calculate token on other instance,
// so we dont overwrite this instance's signature
QJsonWebToken tempTokenObj = *this;
if (m_byteSignature != tempTokenObj.getSignature())
{
return false;
}
return true;
}
QJsonWebToken QJsonWebToken::fromTokenAndSecret(const QString &strToken, const QString &srtSecret)
{
QJsonWebToken tempTokenObj;
// set Token
tempTokenObj.setToken(strToken);
// set Secret
tempTokenObj.setSecret(srtSecret);
// return
return tempTokenObj;
QJsonWebToken tempTokenObj;
// set Token
tempTokenObj.setToken(strToken);
// set Secret
tempTokenObj.setSecret(srtSecret);
// return
return tempTokenObj;
}
void QJsonWebToken::appendClaim(const QString &strClaimType, const QString &strValue)
{
// have to make a copy of the json object, modify the copy and then put it back, sigh
QJsonObject jObj = m_jdocPayload.object();
jObj.insert(strClaimType, strValue);
m_jdocPayload = QJsonDocument(jObj);
// have to make a copy of the json object, modify the copy and then put it back, sigh
QJsonObject jObj = m_jdocPayload.object();
jObj.insert(strClaimType, strValue);
m_jdocPayload = QJsonDocument(jObj);
}
void QJsonWebToken::removeClaim(const QString &strClaimType)
{
// have to make a copy of the json object, modify the copy and then put it back, sigh
QJsonObject jObj = m_jdocPayload.object();
jObj.remove(strClaimType);
m_jdocPayload = QJsonDocument(jObj);
// have to make a copy of the json object, modify the copy and then put it back, sigh
QJsonObject jObj = m_jdocPayload.object();
jObj.remove(strClaimType);
m_jdocPayload = QJsonDocument(jObj);
}
bool QJsonWebToken::isAlgorithmSupported(const QString &strAlgorithm)
{
// TODO : support other algorithms
if (strAlgorithm.compare("HS256", Qt::CaseSensitive) != 0 && // HMAC using SHA-256 hash algorithm
strAlgorithm.compare("HS384", Qt::CaseSensitive) != 0 && // HMAC using SHA-384 hash algorithm
strAlgorithm.compare("HS512", Qt::CaseSensitive) != 0 /*&& // HMAC using SHA-512 hash algorithm
strAlgorithm.compare("RS256", Qt::CaseSensitive) != 0 && // RSA using SHA-256 hash algorithm
strAlgorithm.compare("RS384", Qt::CaseSensitive) != 0 && // RSA using SHA-384 hash algorithm
strAlgorithm.compare("RS512", Qt::CaseSensitive) != 0 && // RSA using SHA-512 hash algorithm
strAlgorithm.compare("ES256", Qt::CaseSensitive) != 0 && // ECDSA using P-256 curve and SHA-256 hash algorithm
strAlgorithm.compare("ES384", Qt::CaseSensitive) != 0 && // ECDSA using P-384 curve and SHA-384 hash algorithm
strAlgorithm.compare("ES512", Qt::CaseSensitive) != 0*/) // ECDSA using P-521 curve and SHA-512 hash algorithm
{
return false;
}
return true;
// TODO : support other algorithms
if (strAlgorithm.compare("HS256", Qt::CaseSensitive) != 0 && // HMAC using SHA-256 hash algorithm
strAlgorithm.compare("HS384", Qt::CaseSensitive) != 0 && // HMAC using SHA-384 hash algorithm
strAlgorithm.compare("HS512", Qt::CaseSensitive) != 0 /*&& // HMAC using SHA-512 hash algorithm
strAlgorithm.compare("RS256", Qt::CaseSensitive) != 0 && // RSA using SHA-256 hash algorithm
strAlgorithm.compare("RS384", Qt::CaseSensitive) != 0 && // RSA using SHA-384 hash algorithm
strAlgorithm.compare("RS512", Qt::CaseSensitive) != 0 && // RSA using SHA-512 hash algorithm
strAlgorithm.compare("ES256", Qt::CaseSensitive) != 0 && // ECDSA using P-256 curve and SHA-256 hash algorithm
strAlgorithm.compare("ES384", Qt::CaseSensitive) != 0 && // ECDSA using P-384 curve and SHA-384 hash algorithm
strAlgorithm.compare("ES512", Qt::CaseSensitive) != 0*/) // ECDSA using P-521 curve and SHA-512 hash algorithm
{
return false;
}
return true;
}
QStringList QJsonWebToken::supportedAlgorithms()
{
// TODO : support other algorithms
return QStringList() << "HS256" << "HS384" << "HS512";
// TODO : support other algorithms
return QStringList() << "HS256" << "HS384" << "HS512";
}

View File

@@ -332,7 +332,7 @@ public:
\sa QJsonWebToken::getRandLength()
*/
void setRandLength(const int &intRandLength);
void setRandLength(int intRandLength);
/**
@@ -397,8 +397,8 @@ private:
QString m_strSecret;
QString m_strAlgorithm;
int m_intRandLength ;
QString m_strRandAlphanum;
int m_intRandLength = 10;
QString m_strRandAlphanum = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
// helpers
QByteArray m_byteAllData;