Command line tools for designing certificate templates, instantiating a certificate batch, and import/export tasks
See example of certificate template and batch creation in sample_data.
For more information on working with V3 alpha/beta, please see the docs here.
-
Ensure you have an python environment. Recommendations
-
Git clone the repository and change to the directory
git clone https://github.com/blockchain-certificates/cert-tools.git && cd cert-tools- Run the setup script
pip install .The cert-tools setup script installs 2 scripts, which are described below:
create-certificate-template -c conf.iniThe conf.ini fields are described below. Optional arguments are in brackets
create-certificate-template --help
usage: create_v2_certificate_template.py [-h] [-c MY_CONFIG]
[--data_dir DATA_DIR]
[--issuer_logo_file ISSUER_LOGO_FILE]
[--cert_image_file CERT_IMAGE_FILE]
[--issuer_url ISSUER_URL]
[--issuer_certs_url ISSUER_CERTS_URL]
--issuer_email ISSUER_EMAIL
--issuer_name ISSUER_NAME
--issuer_id ISSUER_ID [--issuer_key ISSUER_KEY]
[--certificate_description CERTIFICATE_DESCRIPTION]
--certificate_title CERTIFICATE_TITLE
--criteria_narrative CRITERIA_NARRATIVE
[--template_dir TEMPLATE_DIR]
[--template_file_name TEMPLATE_FILE_NAME]
[--hash_emails]
[--revocation_list REVOCATION_LIST]
[--issuer_public_key ISSUER_PUBLIC_KEY]
--badge_id BADGE_ID
[--issuer_signature_lines ISSUER_SIGNATURE_LINES]
[--additional_global_fields ADDITIONAL_GLOBAL_FIELDS]
[--additional_per_recipient_fields ADDITIONAL_PER_RECIPIENT_FIELDS]
Args that start with '--' (eg. --data_dir) can also be set in a config file (./cert-tools/conf.ini or specified via -c). Config file syntax allows: key=value, flag=true, stuff=[a,b,c] (for details, see syntax at https://goo.gl/R74nmi). If an arg is specified in more than one place, then commandline values override config file values which override defaults.
Argument details:
-h, --help show this help message and exit
-c MY_CONFIG, --my-config MY_CONFIG
config file path (default: None)
--data_dir DATA_DIR where data files are located (default: None)
--issuer_logo_file ISSUER_LOGO_FILE
issuer logo image file, png format (default: None)
--cert_image_file CERT_IMAGE_FILE
issuer logo image file, png format (default: None)
--issuer_url ISSUER_URL
issuer URL (default: None)
--issuer_certs_url ISSUER_CERTS_URL
issuer certificates URL (default: None)
--issuer_email ISSUER_EMAIL
issuer email (default: None)
--issuer_name ISSUER_NAME
issuer name (default: None)
--issuer_id ISSUER_ID
issuer profile (default: None)
--issuer_key ISSUER_KEY
issuer issuing key (default: None)
--certificate_description CERTIFICATE_DESCRIPTION
the display description of the certificate (default:
None)
--certificate_title CERTIFICATE_TITLE
the title of the certificate (default: None)
--criteria_narrative CRITERIA_NARRATIVE
criteria narrative (default: None)
--template_dir TEMPLATE_DIR
the template output directory (default: None)
--template_file_name TEMPLATE_FILE_NAME
the template file name (default: None)
--hash_emails whether to hash emails in the certificate (default:
False)
--revocation_list REVOCATION_LIST
issuer revocation list (default: None)
--issuer_public_key ISSUER_PUBLIC_KEY
issuer public key (default: None)
--badge_id BADGE_ID badge id (default: None)
--issuer_signature_lines ISSUER_SIGNATURE_LINES
issuer signature lines (default: None)
--additional_global_fields ADDITIONAL_GLOBAL_FIELDS
additional global fields (default: None)
--additional_per_recipient_fields ADDITIONAL_PER_RECIPIENT_FIELDS
additional per-recipient fields (default: None)
Creates a certificate template populated with the setting you provide in the conf.ini file. This will not contain recipient-specific data; such fields will be populated with merge tags.
instantiate-certificate-batch -c conf.ini
Populates the certificate template (created by the previous script) with recipient data from a csv file. It generates a certificate per recipient based on the values in the csv file.
The csv file location is configurable via the conf.ini file.
The csv file must always contain:
- name
- pubkey
- identity
The conf.ini fields are described below. Optional arguments are in brackets
instantiate-certificate-batch --help
usage: instantiate_v2_certificate_batch.py [-h] [-c MY_CONFIG]
[--data_dir DATA_DIR]
[--issuer_certs_url ISSUER_CERTS_URL]
[--template_dir TEMPLATE_DIR]
[--template_file_name TEMPLATE_FILE_NAME]
[--hash_emails]
[--additional_per_recipient_fields ADDITIONAL_PER_RECIPIENT_FIELDS]
[--unsigned_certificates_dir UNSIGNED_CERTIFICATES_DIR]
[--roster ROSTER]
Args that start with '--' (eg. --data_dir) can also be set in a config file (./cert-tools/conf.ini or specified via -c). Config file syntax allows: key=value, flag=true, stuff=[a,b,c] (for details, see syntax at https://goo.gl/R74nmi). If an arg is specified in more than one place, then commandline values override config file values which override defaults.
Argument details:
-h, --help show this help message and exit
-c MY_CONFIG, --my-config MY_CONFIG
config file path (default: None)
--data_dir DATA_DIR where data files are located (default: None)
--issuer_certs_url ISSUER_CERTS_URL
issuer certificates URL (default: None)
--template_dir TEMPLATE_DIR
the template output directory (default: None)
--template_file_name TEMPLATE_FILE_NAME
the template file name (default: None)
--hash_emails whether to hash emails in the certificate (default:
False)
--additional_per_recipient_fields ADDITIONAL_PER_RECIPIENT_FIELDS
additional per-recipient fields (default: None)
--unsigned_certificates_dir UNSIGNED_CERTIFICATES_DIR
output directory for unsigned certificates (default:
None)
--roster ROSTER roster file name (default: None)
You can specify additional global fields (fields that apply for every certificate in the batch) and additional per-recipient fields (fields that you will specify per-recipient).
When adding either global or per-recipient custom fields, you must define each of your new terms in a JSON-LD context. You can either point to an existing JSON-LD context, or embed them directly in the context of the certificate. For an example of the latter, see the JSON-LD specification section 3.1. In this case, the @context value would be an array listing the existing context links, and your new definition.
Examples of both options are below:
{
"@context": [
"https://w3id.org/openbadges/v2",
"https://w3id.org/blockcerts/v2",
"https://your-custom-context/v1", <-- option 1: point to custom JSON-LD context
{ <-- option 2: directly embed in certificate
"xyz_custom_field": "http://path/to/xyz_custom_field",
... // and all other custom fields
}
]
}
You can specify custom global fields in the conf.ini file with the additional_global_fields entry
For each additional global field, you must indicate:
- the jsonpath to the field
- the global value to use
Example:
conf.ini:
additional_global_fields = {"fields": [{"path": "$.certificate.subtitle","value": "custom subtitle"}]}
or, expanded for readability:
additional_global_fields = {
"fields":
[
{
"path": "$.certificate.subtitle",
"value": "custom subtitle"
}
]
}
See above note on (current) manual step of defining custom JSON-LD context.
Per-recipient fields are specified in a combination of the conf.ini file, with the additional_per_recipient_fields entry, and the .csv file containing per-recipient data. Per-recipient fields are used in both template creation and certificate instantiaion. During the template creation process, we apply placeholder merge tags as values. This helps you preview your template before running instantiate_certificate_batch.py.
For each additional per-recipient field, you must indicate the following in the additional_per_recipient_fields config field:
- the jsonpath to the field
- the merge_tag placeholder to use
- the csv column where the value (per recipient) can be found. This is used by instantiate_certificate_batch
Example:
conf.ini version:
additional_per_recipient_fields = {"fields": [{"path": "$.xyz_custom_field","value": "*|THIS WILL CONTAIN XYZ CUSTOM VALUES|*","csv_column": "xyz_custom_field"}]}
above expanded for readability:
TODO
create-revocation-addresses -k tpubD6NzV...H66KUZEBkf
Generates Bitcoin addresses using an HD extended public (or private) key to be used as the issuer's revocation addresses for the certificates. This would be useful only if the issuer requires to be able to revoke specific certificates later on. It creates a list of addresses that could then be easily merged with the roster file, e.g. using unix's paste command.
To create 20 revocation address for a testnet extended public key for the first batch of 2016 certificates run:
echo "revkey" > rev_addresses.txt
create-revocation-addresses -n 20 -p "2016/1" -k tpubD6NzV...H66KUZEBkf >> rev_addresses.txt
To merge to roster (in unix) run:
paste -d , roster.txt rev_addresses.txt > roster_with_rev.txt
See sample_data for example configuration and output. conf-mainnet.ini was used to create a batch of 2 unsigned certificates on the Bitcoin blockchain.
The steps were:
- Create the template
- Update the config file to contain the correct data to populate the certificates
- Place the needed images in
images/and point to them in the config file - Run
create_certificate_template.py, which resulted in the certificate template/certificate_templates/test.json
- Instantiate the batch
- Add the recipient roster (in this case
rosters/roster_testnet.csv) with the recipient's Bitcoin addresses. - Run 'instantiate_certificate_batch.py', which resulted in the files in
unsigned_certificates
- Add the recipient roster (in this case
Then the unsigned certificates were copied to cert-issuer for signing and issuing on the blockchain.
Contact us at the Blockcerts community forum.