lib-hpcr

Introduction

The library has been developed to simply the process for provisioning HPVS on both IBM Cloud and On Prem. For more details regarding HPVS, refer Confidential computing with LinuxONE

This library depends on Sashwat-K/hpcr-encryption-certificate and Sashwat-K/hpcr-contract-schema Go libraries to get latest HPCR certificate and HPCR contract schema respectively.

Usage

HpcrGetAttestationRecords()

This function decrypts encrypted attestation records.

Example

import "github.com/Sashwat-K/lib-hpcr/attestation"

func main() {
    decryptedAttestationRecords, err := HpcrGetAttestationRecords(encryptedChecksum, privateKey)
}

Input(s)

1. Encrypted attestation records
2. Private key

Output(s)

1. Decrypted attestation records

HpcrDownloadEncryptionCertificates()

This function downloads HPCR encryption certificates from IBM Cloud.

Example

import "github.com/Sashwat-K/lib-hpcr/certificate"

func main() {
    certs, err := HpcrDownloadEncryptionCertificates(sampleEncryptionCertVersionsList)
}

Input(s)

1. List of versions to download (eg: ["1.1.14", "1.1.15"])

Output(s)

1. Certificates and versions as JSON string

HpcrGetEncryptionCertificateFromJson()

This function returns encryption certificate and version from HpcrDownloadEncryptionCertificates() output.

Example

import "github.com/Sashwat-K/lib-hpcr/certificate"

func main() {
    version, cert, err := HpcrGetEncryptionCertificateFromJson(sampleJsonData, desiredVersion)
}

Input(s)

1. Encryption certificate JSON string
2. Version name

Output(s)

1. Version name
2. Encryption Certificate

HpcrText()

This function generates Base64 for given string.

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func main() {
    base64, inputSha256, outputSha256, err := HpcrText(sampleStringData)
}

Input(s)

1. Text to encode

Output(s)

1. Base64 of input
2. Checksum of input
3. Checksum of output

HpcrTextEncrypted()

This function encrypts text and formats text as per hyper-protect-basic.<encoded-encrypted-password>.<encoded-encrypted-data>.

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func main() {
    encryptedText, inputSha256, outputSha256, err := HpcrTextEncrypted(sampleStringData, encryptionCertificate)
}

Input(s)

1. Text to encrypt
2. Encryption certificate (optional)

Output(s)

1. Encrypted text
2. Checksum of input
3. Checksum of output

HpcrJson()

This function generates Base64 of JSON input

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func main() {
    base64, inputSha256, outputSha256, err := HpcrJson(sampleStringJson)
}

Input(s)

1. Text to encode

Output(s)

1. Base64 of input
2. Checksum of input
3. Checksum of output

HpcrJsonEncrypted()

This function generates encrypts JSON and formats text as per hyper-protect-basic.<encoded-encrypted-password>.<encoded-encrypted-data>.

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func main() {
    encryptedJson, inputSha256, outputSha256, err := HpcrJsonEncrypted(sampleStringJson, encryptionCertificate)
}

Input(s)

1. JSON text to encrypt
2. Encryption certificate (optional)

Output(s)

1. Encrypted text
2. Checksum of input
3. Checksum of output

HpcrTgz()

This function generates base64 of TGZ that contains files under the given folder

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func main() {
    encodedTgz, inputSha256, outputSha256, err := HpcrTgz(composePath)
}

Input(s)

1. Path of folder

Output(s)

1. Base64 of TGZ where TGZ is contents of given folder
2. Checksum of imput
3. Checksum of output

HpcrTgzEncrypted()

This function first generates base64 of TGZ that contains files under the given folder and then encrypts the data as per hyper-protect-basic.<encoded-encrypted-password>.<encoded-encrypted-data>.

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func main() {
    encodedTgz, inputSha256, outputSha256, err := HpcrTgzEncrypted(composePath, encryptionCertificate)
}

Input(s)

1. Path of folder

Output(s)

1. encrypted base64 of TGZ where TGZ is contents of given folder
2. Checksum of input
3. Checksum of output

HpcrContractSignedEncrypted()

This function generates a signed and encrypted contract with format hyper-protect-basic.<encoded-encrypted-password>.<encoded-encrypted-data>.

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func main() {
    signedEncryptedContract, inputSha256, outputSha256, err := HpcrContractSignedEncrypted(contract, encryptionCertificate, privateKey)
}

Input(s)

1. Contract
2. Encryption certificate (optional)
3. Private Key for signing

Output(s)

1. Signed and encrypted contract
2. Checksum of input
3. Checksum of output

HpcrContractSignedEncryptedContractExpiry()

This function generates a signed and encrypted contract with contract expiry enabled. The output will be of the format hyper-protect-basic.<encoded-encrypted-password>.<encoded-encrypted-data>.

Example

import "github.com/Sashwat-K/lib-hpcr/contract"

func usingCsrParams() {
    sampleCeCSRPems = map[string]interface{}{
		"country":  "IN",
		"state":    "Karnataka",
		"location": "Bangalore",
		"org":      "IBM",
		"unit":     "ISDL",
		"domain":   "HPVS",
		"mail":     "[email protected]",
	}

    signedEncryptedCEContract, inputSha256, outputSha256, err := HpcrContractSignedEncryptedContractExpiry(contract, encryptionCertificate, privateKey, caCert, caKey, string(csrParams), "", sampleContractExpiryDays)
}

func usingCsrPem() {
    signedEncryptedCEContract, inputSha256, outputSha256, err := HpcrContractSignedEncryptedContractExpiry(contract, encryptionCertificate, privateKey, caCert, caKey, "", csr, sampleContractExpiryDays)
}

Input(s)

1. Contract
2. Encryption certificate (optional)
3. Private Key for signing
4. CA Certificate
5. CA Key
6. CSR Parameter JSON as string
7. CSR PEM file
8. Expiry of contract in number of days

The point 6 and 7 if one of. That is, either CSR parameters or CSR PEM file.

The CSR parameters should be of the format:-

"country":  "IN",
"state":    "Karnataka",
"location": "Bangalore",
"org":      "IBM",
"unit":     "ISDL",
"domain":   "HPVS",
"mail":     "[email protected]"

Output(s)

1. Signed and encrypted contract
2. Checksum of input
3. Checksum of output

HpcrSelectImage()

This function selects the latest HPCR image details from image list out from IBM Cloud images API.

Example

import "github.com/Sashwat-K/lib-hpcr/image"

func main() {
    imageId, imageName, imageChecksum, ImageVersion, err := HpcrSelectImage(imageJsonList, version)
}

Input(s)

1. Image JSON from IBM Cloud images API
2. version to select (optional)

Output(s)

1. Image ID
2. Image name
3. Image checksum
4. Image version

Other Repos

1. Sashwat-K/hpcr-encryption-certificate - Go library that gets latest HPCR encryption certificate
2. Sashwat-K/hpcr-contract-schema - Go library that gets latest HPCR contract schema

Questions

Shoot mail @ [email protected]