Verify a New Zealand COVID Pass

A group of functions for verifying New Zealand COVID Passes. More...

Typedefs
typedef enum nzcp_error	nzcp_error
	The nzcp_error enum used for verfication errors. More...

Enumerations
enum	nzcp_error
	The nzcp_error enum used for verfication errors. More...

Functions
nzcp_error	nzcp_verify_pass_uri (uint8_t *pass_uri, nzcp_verification_result *verification_result, bool is_example)
	Verifies New Zealand COVID Pass URI. More...
void	nzcp_free_verification_result (nzcp_verification_result *verification_result)
	Frees nzcp_verification_result struct. Run this after you're done with the result. More...
const char *	nzcp_error_string (nzcp_error error)
	Returns the error description for the given error code. More...

Detailed Description

A group of functions for verifying New Zealand COVID Passes.

Example Usage

#include <nzcp.h>
 
// initiate verification result on stack
nzcp_verification_result verification_result;
 
// verify pass
// last argument determines if it's example or live MOH DID document
nzcp_error error = nzcp_verify_pass_uri(PASS_URI, &verification_result, 1);
 
// check for error
if (error == NZCP_E_SUCCESS) {
  printf("jti: %s\n", verification_result.jti);
  printf("iss: %s\n", verification_result.iss);
  printf("nbf: %d\n", verification_result.nbf);
  printf("exp: %d\n", verification_result.exp);
  printf("given_name: %s\n", verification_result.given_name);
  printf("family_name: %s\n", verification_result.family_name);
  printf("dob: %s\n", verification_result.dob);
}
else {
  printf("error: %s\n", nzcp_error_string(error));
}
 
// free memory of verification result properties
nzcp_free_verification_result(&verification_result);

Typedef Documentation

nzcp_error

typedef enum nzcp_error nzcp_error

The nzcp_error enum used for verfication errors.

This is the type used to represent NZCP errors in the nzcp_verify_pass_uri function.

Enumeration Type Documentation

nzcp_error

enum nzcp_error

The nzcp_error enum used for verfication errors.

This is the type used to represent NZCP errors in the nzcp_verify_pass_uri function.

Function Documentation

nzcp_error_string()

const char* nzcp_error_string

(

nzcp_error

error

)

Returns the error description for the given error code.

Parameters

[in]

error

error code

Returns

const char*

nzcp_free_verification_result()

void nzcp_free_verification_result

(

nzcp_verification_result *

verification_result

)

Frees nzcp_verification_result struct. Run this after you're done with the result.

Parameters

[in]

verification_result

Pointer to verification result struct

nzcp_verify_pass_uri()

nzcp_error nzcp_verify_pass_uri	(	uint8_t *	pass_uri,
		nzcp_verification_result *	verification_result,
		bool	is_example
	)

Verifies New Zealand COVID Pass URI.

Parameters

[in]	pass_uri	Null-terminted buffer with the URI
[out]	verification_result	Pointer to verification result struct
[in]	is_example	Whether the pass_uri uses example or live MOH DID document

Returns

nzcp_error