KSI Signature Builder

Typedefs
typedef struct KSI_SignatureBuilder_st	KSI_SignatureBuilder

Functions
int	KSI_SignatureBuilder_openFromSignature (const KSI_Signature *sig, KSI_SignatureBuilder **builder)
int	KSI_SignatureBuilder_openFromAggregationResp (const KSI_AggregationResp *resp, KSI_SignatureBuilder **builder)
int	KSI_SignatureBuilder_open (KSI_CTX *ctx, KSI_SignatureBuilder **builder)
int	KSI_SignatureBuilder_close (KSI_SignatureBuilder *builder, KSI_uint64_t rootLevel, KSI_Signature **sig)
void	KSI_SignatureBuilder_free (KSI_SignatureBuilder *builder)
int	KSI_SignatureBuilder_setCalendarHashChain (KSI_SignatureBuilder *builder, KSI_CalendarHashChain *cal)
int	KSI_SignatureBuilder_addAggregationChain (KSI_SignatureBuilder *builder, KSI_AggregationHashChain *aggr)
int	KSI_SignatureBuilder_appendAggregationChain (KSI_SignatureBuilder *builder, KSI_AggregationHashChain *aggr)
int	KSI_SignatureBuilder_createSignatureWithAggregationChain (KSI_SignatureBuilder *builder, KSI_AggregationHashChain *aggr, KSI_Signature **sig)
int	KSI_SignatureBuilder_setCalendarAuthRecord (KSI_SignatureBuilder *builder, KSI_CalendarAuthRec *calAuth)
int	KSI_SignatureBuilder_setPublication (KSI_SignatureBuilder *builder, KSI_PublicationRecord *pub)
int	KSI_SignatureBuilder_setRFC3161 (KSI_SignatureBuilder *builder, KSI_RFC3161 *rfc3161)

Detailed Description

The signature builder is used to create a signature object from components. The interface will verify the signature internally before returning it to the caller.

Typedef Documentation

KSI_SignatureBuilder

typedef struct KSI_SignatureBuilder_st KSI_SignatureBuilder

Signature builder object.

Function Documentation

KSI_SignatureBuilder_addAggregationChain()

int KSI_SignatureBuilder_addAggregationChain	(	KSI_SignatureBuilder *	builder,
		KSI_AggregationHashChain *	aggr
	)

This function adds an aggregation chain to the signature.

Parameters

[in]	builder	Pointer to the builder.
[in]	aggr	Aggregation chain.

Note

It is the responsibility of the caller to free the input parameters after use.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_SignatureBuilder_appendAggregationChain()

int KSI_SignatureBuilder_appendAggregationChain	(	KSI_SignatureBuilder *	builder,
		KSI_AggregationHashChain *	aggr
	)

This function appends the aggregation chain to the signature. The difference between KSI_SignatureBuilder_addAggregationChain is that chain is appended to the beggining of the chain list and aggregation time and chain index are updated.

Parameters

[in]	builder	Pointer to the builder.
[in]	aggr	Aggregation hash chain.

Note

It is the responsibility of the caller to free the input parameters after use.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_SignatureBuilder_close()

int KSI_SignatureBuilder_close	(	KSI_SignatureBuilder *	builder,
		KSI_uint64_t	rootLevel,
		KSI_Signature **	sig
	)

If the signature is set up properly and the resulting signature is internally verifiable, then the function closes the signature builder and returns via output parameter the resulting signature.

Parameters

[in]	builder	Pointer to signature builder.
[in]	rootLevel	The level of the input hash (usually 0). This is used only for the verification.
[out]	sig	Pointer to the receiving pointer.

Note

The caller must also call KSI_SignatureBuilder_free on the builder object.

It is the responsibility of the caller to free the resulting signature object.

See also

KSI_SignatureBuilder_free, KSI_Signature_free.

Returns

status code (KSI_OK when operation succeeded, KSI_INVALID_STATE when the building of the signature is in an invalid state, otherwise an error code).

KSI_SignatureBuilder_createSignatureWithAggregationChain()

int KSI_SignatureBuilder_createSignatureWithAggregationChain	(	KSI_SignatureBuilder *	builder,
		KSI_AggregationHashChain *	aggr,
		KSI_Signature **	sig
	)

This function appends the aggregation chain to the signature and returns the appended signature. To use this interface, first open a signature builder from a signature (KSI_SignatureBuilder_openFromSignature), then get as many appended signatures as needed and finally free the signature builder (KSI_SignatureBuilder_free).

Parameters

[in]	builder	Pointer to the builder.
[in]	aggr	Aggregation hash chain.
[out]	sig	Pointer to the receiving pointer.

Note

It is the responsibility of the caller to free the input parameters after use.

There is no need to close the signature builder after use.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_SignatureBuilder_free()

void KSI_SignatureBuilder_free

(

KSI_SignatureBuilder *

builder

)

Cleanup method for the builder.

Parameters

[in]

builder

Pointer to the builder.

KSI_SignatureBuilder_open()

int KSI_SignatureBuilder_open	(	KSI_CTX *	ctx,
		KSI_SignatureBuilder **	builder
	)

Creates a new instance of the signature builder.

Parameters

[in]	ctx	The KSI context.
[out]	builder	Pointer to the receiving pointer.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

See also

KSI_SignatureBuilder_close, KSI_SignatureBuilder_free

KSI_SignatureBuilder_openFromAggregationResp()

int KSI_SignatureBuilder_openFromAggregationResp	(	const KSI_AggregationResp *	resp,
		KSI_SignatureBuilder **	builder
	)

Creates a new instance of the signature builder. The builder is initialized with the aggregation response resp.

Parameters

[in]	resp	Aggregation response.
[out]	builder	Pointer to the receiving pointer.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

Note

It is users responsibility to verify the resulting singature.

It is the responsibility of the caller to free the input parameters after use.

See also

KSI_Signature_verifyWithPolicy

KSI_SignatureBuilder_openFromSignature()

int KSI_SignatureBuilder_openFromSignature	(	const KSI_Signature *	sig,
		KSI_SignatureBuilder **	builder
	)

Creates a new instance of the signature builder. The builder is initialized with a copy of the input signature sig.

Parameters

[in]	sig	KSI signature instance.
[out]	builder	Pointer to the receiving pointer.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

Note

It is the responsibility of the caller to free the input parameters after use.

KSI_SignatureBuilder_setCalendarAuthRecord()

int KSI_SignatureBuilder_setCalendarAuthRecord	(	KSI_SignatureBuilder *	builder,
		KSI_CalendarAuthRec *	calAuth
	)

This function sets the calendar authentication record of the signature.

Parameters

[in]	builder	Pointer to the builder.
[in]	calAuth	Calendar chain authentication record.

Note

It is the responsibility of the caller to free the input parameters after use.

Calling this function more than once on a signature builder results in an error.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_SignatureBuilder_setCalendarHashChain()

int KSI_SignatureBuilder_setCalendarHashChain	(	KSI_SignatureBuilder *	builder,
		KSI_CalendarHashChain *	cal
	)

This function sets the calendar hash chain of the signature.

Parameters

[in]	builder	Pointer to the builder.
[in]	cal	Calendar chain.

Note

Calling this function more than once on a signature builder results in an error.

It is the responsibility of the caller to free the input parameters after use.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_SignatureBuilder_setPublication()

int KSI_SignatureBuilder_setPublication	(	KSI_SignatureBuilder *	builder,
		KSI_PublicationRecord *	pub
	)

This function sets the publication record of the signature.

Parameters

[in]	builder	Pointer to the builder.
[in]	pub	Publication record.

Note

Calling this function more than once on a signature builder results in an error.

It is the responsibility of the caller to free the input parameters after use.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).

KSI_SignatureBuilder_setRFC3161()

int KSI_SignatureBuilder_setRFC3161	(	KSI_SignatureBuilder *	builder,
		KSI_RFC3161 *	rfc3161
	)

This function sets the RFC3161 record of the signature.

Parameters

[in]	builder	Pointer to the builder.
[in]	rfc3161	RFC3161 record.

Note

Calling this function more than once on a signature builder results in an error.

It is the responsibility of the caller to free the input parameters after use.

Returns

status code (KSI_OK, when operation succeeded, otherwise an error code).