generate-encrypted-image v1.3.2

HTTP endpoint to generate an encrypted image in the xCORE flash format using the XMOS tools.

Endpoints

GET generate-encrypted-image.synapticon.com/keyIds

This endpoint authenticates with Synwave using the provided credentials and uses the received access token to retrieve a list of valid (non-EOL) key IDs for encrypting firmware. Use one of the returned keys to encrypt firmware or bootloader.

The response content type is 'application/json'.

POST generate-encrypted-image.synapticon.com/:keyId

This endpoint uses the provided key ID to retrieve the authentication and decryption keys from Synwave. It then employs the xflash program to encrypt the firmware and returns it to the caller. The provided zip file must include the *.xe file.

The response content type can be either 'application/octet-stream' or 'application/zip'. Callers are required to provide the 'Content-Type' and 'Accept' HTTP headers, which should be set as 'application/octet-stream' or 'application/zip'.

POST generate-encrypted-image.synapticon.com/bootloader/:keyId

This endpoint uses the provided key ID to retrieve the authentication and decryption keys from Synwave. It then employs the xflash program to encrypt the bootloader and returns it to the caller. The provided zip file must include the loader.o and *.xe files.

The response content type is 'application/zip'. Callers are required to provide the 'Content-Type' and 'Accept' HTTP headers, which should be set as 'application/zip'.

GET generate-encrypted-image.synapticon.com/signcom/keyIds

This endpoint authenticates with Synwave using the provided credentials and uses the received access token to retrieve a list of valid (non-EOL) key IDs for signing NetX binaries. Use one of the returned keys to sign the NetX binary.

The response content type is 'application/json'.

POST generate-encrypted-image.synapticon.com/signcom/:keyId

This endpoint uses the provided key ID to retrieve the signing key from Synwave. This signing key is then used to sign NetX communication firmware via the hboot image sign Windows application running through Wine. If you set the content type to 'application/octet-stream', you must provide a .nai file. On the other hand, if you choose 'application/zip', ensure that the provided ZIP file contains a valid .nai file inside.

The response content type can be either 'application/octet-stream' or 'application/zip'. Callers are required to provide the 'Content-Type' and 'Accept' HTTP headers, which should be set as 'application/octet-stream' or 'application/zip'.