284 lines
12 KiB
C
284 lines
12 KiB
C
|
// CkJwsW.h: interface for the CkJwsW class.
|
||
|
|
//
|
||
|
|
//////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
// This header is generated for Chilkat 11.3.0
|
||
|
|
|
||
|
|
#ifndef _CkJwsW_H
|
||
|
|
#define _CkJwsW_H
|
||
|
|
|
||
|
|
#include "chilkatDefs.h"
|
||
|
|
#include "CkString.h"
|
||
|
|
#include "CkWideCharBase.h"
|
||
|
|
|
||
|
|
class CkStringBuilderW;
|
||
|
|
class CkBinDataW;
|
||
|
|
class CkJsonObjectW;
|
||
|
|
class CkPrivateKeyW;
|
||
|
|
class CkPublicKeyW;
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
#if !defined(__sun__) && !defined(__sun)
|
||
|
|
#pragma pack (push, 8)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
// CLASS: CkJwsW
|
||
|
|
class CK_VISIBLE_PUBLIC CkJwsW : public CkWideCharBase
|
||
|
|
{
|
||
|
|
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
// Don't allow assignment or copying these objects.
|
||
|
|
CkJwsW(const CkJwsW &);
|
||
|
|
CkJwsW &operator=(const CkJwsW &);
|
||
|
|
|
||
|
|
public:
|
||
|
|
CkJwsW(void);
|
||
|
|
virtual ~CkJwsW(void);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
static CkJwsW *createNew(void);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
void CK_VISIBLE_PRIVATE inject(void *impl);
|
||
|
|
|
||
|
|
// May be called when finished with the object to free/dispose of any
|
||
|
|
// internal resources held by the object.
|
||
|
|
void dispose(void);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// BEGIN PUBLIC INTERFACE
|
||
|
|
|
||
|
|
// ----------------------
|
||
|
|
// Properties
|
||
|
|
// ----------------------
|
||
|
|
// The number of signatures contained in this JWS.
|
||
|
|
int get_NumSignatures(void);
|
||
|
|
|
||
|
|
// Controls whether to use the JWS Compact Serialization or JWS JSON Serialization
|
||
|
|
// when creating JWSs. The default value is true, which is to choose the compact
|
||
|
|
// serialization when possible. If multiple signatures exist, or if any unprotected
|
||
|
|
// headers exist, then JWS JSON Serialization is used regardless of this property
|
||
|
|
// setting.
|
||
|
|
bool get_PreferCompact(void);
|
||
|
|
// Controls whether to use the JWS Compact Serialization or JWS JSON Serialization
|
||
|
|
// when creating JWSs. The default value is true, which is to choose the compact
|
||
|
|
// serialization when possible. If multiple signatures exist, or if any unprotected
|
||
|
|
// headers exist, then JWS JSON Serialization is used regardless of this property
|
||
|
|
// setting.
|
||
|
|
void put_PreferCompact(bool newVal);
|
||
|
|
|
||
|
|
// Controls whether to use the flattened or general JWE JSON Serialization when
|
||
|
|
// creating JWSs. The default value is true, which is to choose the flattened
|
||
|
|
// serialization when possible. If multiple signatures exist, then the general
|
||
|
|
// (non-flattened) JWS JSON Serialization is used regardless of this property
|
||
|
|
// setting.
|
||
|
|
bool get_PreferFlattened(void);
|
||
|
|
// Controls whether to use the flattened or general JWE JSON Serialization when
|
||
|
|
// creating JWSs. The default value is true, which is to choose the flattened
|
||
|
|
// serialization when possible. If multiple signatures exist, then the general
|
||
|
|
// (non-flattened) JWS JSON Serialization is used regardless of this property
|
||
|
|
// setting.
|
||
|
|
void put_PreferFlattened(bool newVal);
|
||
|
|
|
||
|
|
// This is a catch-all property to be used for uncommon needs. This property
|
||
|
|
// defaults to the empty string and should typically remain empty.
|
||
|
|
void get_UncommonOptions(CkString &str);
|
||
|
|
// This is a catch-all property to be used for uncommon needs. This property
|
||
|
|
// defaults to the empty string and should typically remain empty.
|
||
|
|
const wchar_t *uncommonOptions(void);
|
||
|
|
// This is a catch-all property to be used for uncommon needs. This property
|
||
|
|
// defaults to the empty string and should typically remain empty.
|
||
|
|
void put_UncommonOptions(const wchar_t *newVal);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// ----------------------
|
||
|
|
// Methods
|
||
|
|
// ----------------------
|
||
|
|
// Creates and returns the JWS containing one or more signatures according to the
|
||
|
|
// previously set payload, headers, and keys.
|
||
|
|
bool CreateJws(CkString &outStr);
|
||
|
|
// Creates and returns the JWS containing one or more signatures according to the
|
||
|
|
// previously set payload, headers, and keys.
|
||
|
|
const wchar_t *createJws(void);
|
||
|
|
|
||
|
|
// Creates and returns the JWS by appending it to the contents of sbJws.
|
||
|
|
bool CreateJwsSb(CkStringBuilderW &sbJws);
|
||
|
|
|
||
|
|
// Returns the JWS payload. The charset specifies the byte representation to be used
|
||
|
|
// in interpreting the bytes of the payload. (For example, utf-8 , windows-1252 ,
|
||
|
|
// utf-16 , etc.)
|
||
|
|
bool GetPayload(const wchar_t *charset, CkString &outStr);
|
||
|
|
// Returns the JWS payload. The charset specifies the byte representation to be used
|
||
|
|
// in interpreting the bytes of the payload. (For example, utf-8 , windows-1252 ,
|
||
|
|
// utf-16 , etc.)
|
||
|
|
const wchar_t *getPayload(const wchar_t *charset);
|
||
|
|
// Returns the JWS payload. The charset specifies the byte representation to be used
|
||
|
|
// in interpreting the bytes of the payload. (For example, utf-8 , windows-1252 ,
|
||
|
|
// utf-16 , etc.)
|
||
|
|
const wchar_t *payload(const wchar_t *charset);
|
||
|
|
|
||
|
|
// Returns the JWS payload by appending it to the binData.
|
||
|
|
bool GetPayloadBd(CkBinDataW &binData);
|
||
|
|
|
||
|
|
// Returns the JWS payload by appending it to the sbPayload. The charset specifies the byte
|
||
|
|
// representation to be used in interpreting the bytes of the payload. (For
|
||
|
|
// example, utf-8 , windows-1252 , utf-16 , etc.)
|
||
|
|
bool GetPayloadSb(const wchar_t *charset, CkStringBuilderW &sbPayload);
|
||
|
|
|
||
|
|
// Returns in json the protected header of the signature at the specified index. The
|
||
|
|
// first signature is at index 0. Typically, a JWS has a single signature at index
|
||
|
|
// 0.
|
||
|
|
bool GetProtectedH(int index, CkJsonObjectW &json);
|
||
|
|
|
||
|
|
// Applications should instead call GetProtectedH .
|
||
|
|
//
|
||
|
|
// Returns the protected header for the Nth signature. The index is the index of the
|
||
|
|
// signature. The 1st signature is at index 0. In most cases, a JWS contains a
|
||
|
|
// single signature at index 0.
|
||
|
|
//
|
||
|
|
// The caller is responsible for deleting the object returned by this method.
|
||
|
|
CkJsonObjectW *GetProtectedHeader(int index);
|
||
|
|
|
||
|
|
// Returns in json the original unprotected header of the signature at the
|
||
|
|
// specified index. The first signature is at index 0. Typically, a JWS has a single
|
||
|
|
// signature at index 0.
|
||
|
|
bool GetUnprotectedH(int index, CkJsonObjectW &json);
|
||
|
|
|
||
|
|
// Applications should instead call GetUnprotectedH .
|
||
|
|
//
|
||
|
|
// Returns the optional unprotected header for the Nth signature. The index is the
|
||
|
|
// index of the signature. The 1st signature is at index 0. In most cases, a JWS
|
||
|
|
// contains a single signature at index 0.
|
||
|
|
//
|
||
|
|
// The caller is responsible for deleting the object returned by this method.
|
||
|
|
CkJsonObjectW *GetUnprotectedHeader(int index);
|
||
|
|
|
||
|
|
// Loads a JWS contained in jwsStr.
|
||
|
|
bool LoadJws(const wchar_t *jwsStr);
|
||
|
|
|
||
|
|
// Loads a JWS from the contents of sbJws.
|
||
|
|
bool LoadJwsSb(CkStringBuilderW &sbJws);
|
||
|
|
|
||
|
|
// Sets the MAC key to be used for creating or validating a signature for the
|
||
|
|
// algorithms HS256 , HS384 , or HS512 . The key is an encoded string
|
||
|
|
// representation of the MAC key bytes. The encoding is an encoding, such as base64url
|
||
|
|
// , base64 , hex , etc. The 1st signature is at index 0. (Most JWSs only contain a
|
||
|
|
// single signature.)
|
||
|
|
bool SetMacKey(int index, const wchar_t *key, const wchar_t *encoding);
|
||
|
|
|
||
|
|
// Sets the MAC key to be used for creating or validating a signature for the
|
||
|
|
// algorithms HS256 , HS384 , or HS512 . The key contains the binary bytes of the
|
||
|
|
// MAC key for the Nth signature. The 1st signature is at index 0.
|
||
|
|
bool SetMacKeyBd(int index, CkBinDataW &key);
|
||
|
|
|
||
|
|
// Sets the JWS payload from the contents of payload. The charset specifies the byte
|
||
|
|
// representation to be used for the string that is to be the payload. (For
|
||
|
|
// example, utf-8 , windows-1252 , utf-16 , etc.). If includeBom is true, then the
|
||
|
|
// byte-order-mark (BOM), also known as preamble, if one exists for the given charset,
|
||
|
|
// is included in the payload. Normally, includeBom should be set to false.
|
||
|
|
bool SetPayload(const wchar_t *payload, const wchar_t *charset, bool includeBom);
|
||
|
|
|
||
|
|
// Sets the JWS payload from the contents of binData.
|
||
|
|
bool SetPayloadBd(CkBinDataW &binData);
|
||
|
|
|
||
|
|
// Sets the JWS payload from the contents of sbPayload. The charset specifies the byte
|
||
|
|
// representation to be used for the string that is to be the payload. (For
|
||
|
|
// example, utf-8 , windows-1252 , utf-16 , etc.). If includeBom is true, then the
|
||
|
|
// byte-order-mark (BOM), also known as preamble, if one exists for the given charset,
|
||
|
|
// is included in the payload. Normally, includeBom should be set to false.
|
||
|
|
bool SetPayloadSb(CkStringBuilderW &sbPayload, const wchar_t *charset, bool includeBom);
|
||
|
|
|
||
|
|
// Sets the private key (ECC or RSA) to be used in creating a signature for the
|
||
|
|
// following algorithms:RS256
|
||
|
|
// RS384
|
||
|
|
// RS512
|
||
|
|
// ES256
|
||
|
|
// ES384
|
||
|
|
// ES512
|
||
|
|
// PS256
|
||
|
|
// PS384
|
||
|
|
// PS512
|
||
|
|
// The JWS algorithms are described in RFC 7518, section 3.1. Here is a summary: +--------------+-------------------------------+--------------------+
|
||
|
|
// | "alg" Param | Digital Signature or MAC | Implementation |
|
||
|
|
// | Value | Algorithm | Requirements |
|
||
|
|
// +--------------+-------------------------------+--------------------+
|
||
|
|
// | HS256 | HMAC using SHA-256 | Required |
|
||
|
|
// | HS384 | HMAC using SHA-384 | Optional |
|
||
|
|
// | HS512 | HMAC using SHA-512 | Optional |
|
||
|
|
// | RS256 | RSASSA-PKCS1-v1_5 using | Recommended |
|
||
|
|
// | | SHA-256 | |
|
||
|
|
// | RS384 | RSASSA-PKCS1-v1_5 using | Optional |
|
||
|
|
// | | SHA-384 | |
|
||
|
|
// | RS512 | RSASSA-PKCS1-v1_5 using | Optional |
|
||
|
|
// | | SHA-512 | |
|
||
|
|
// | ES256 | ECDSA using P-256 and SHA-256 | Recommended+ |
|
||
|
|
// | ES384 | ECDSA using P-384 and SHA-384 | Optional |
|
||
|
|
// | ES512 | ECDSA using P-521 and SHA-512 | Optional |
|
||
|
|
// | PS256 | RSASSA-PSS using SHA-256 and | Optional |
|
||
|
|
// | | MGF1 with SHA-256 | |
|
||
|
|
// | PS384 | RSASSA-PSS using SHA-384 and | Optional |
|
||
|
|
// | | MGF1 with SHA-384 | |
|
||
|
|
// | PS512 | RSASSA-PSS using SHA-512 and | Optional |
|
||
|
|
// | | MGF1 with SHA-512 | |
|
||
|
|
// | none | No digital signature or MAC | Optional |
|
||
|
|
// | | performed | |
|
||
|
|
// +--------------+-------------------------------+--------------------+
|
||
|
|
bool SetPrivateKey(int index, CkPrivateKeyW &privKey);
|
||
|
|
|
||
|
|
// Sets a signature's protected header. The index is the index of the signature. The
|
||
|
|
// 1st signature is at index 0. In most cases, a JWS contains a single signature at
|
||
|
|
// index 0.
|
||
|
|
bool SetProtectedHeader(int index, CkJsonObjectW &json);
|
||
|
|
|
||
|
|
// Sets the public key (ECC or RSA) to be used in validating a signature for the
|
||
|
|
// following algorithms:RS256
|
||
|
|
// RS384
|
||
|
|
// RS512
|
||
|
|
// ES256
|
||
|
|
// ES384
|
||
|
|
// ES512
|
||
|
|
// PS256
|
||
|
|
// PS384
|
||
|
|
// PS512
|
||
|
|
bool SetPublicKey(int index, CkPublicKeyW &pubKey);
|
||
|
|
|
||
|
|
// Sets a signature's optional unprotected header. The index is the index of the
|
||
|
|
// signature. The 1st signature is at index 0. In most cases, a JWS contains a
|
||
|
|
// single signature at index 0.
|
||
|
|
bool SetUnprotectedHeader(int index, CkJsonObjectW &json);
|
||
|
|
|
||
|
|
// Validates the Nth signature or MAC using the Nth public key or MAC key.
|
||
|
|
//
|
||
|
|
// Returns 1 if the signature was validated, thus verifying that the signer used
|
||
|
|
// the same MAC key or the matching private key.
|
||
|
|
// Returns 0 if the incorrect public key or MAC key was provided.
|
||
|
|
// Returns -1 for any other error, such as if no public key or MAC key was
|
||
|
|
// previously set for the given index.
|
||
|
|
//
|
||
|
|
// Prior to calling this method, a program should provide the public key or MAC key
|
||
|
|
// via the SetPublicKey, SetMacKey, or SetMacKeyBd methods.
|
||
|
|
//
|
||
|
|
int Validate(int index);
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// END PUBLIC INTERFACE
|
||
|
|
|
||
|
|
|
||
|
|
};
|
||
|
|
#if !defined(__sun__) && !defined(__sun)
|
||
|
|
#pragma pack (pop)
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif
|