Convert an application to run in EnclaveOS.

Prev Next
Post
/v1/tools/converter/convert-app
Body parameters
Expand All
object
inputImageName
string Required

Registry and image name for the input container, e.g. my-registry/sample-app:latest

outputImageName
string Required

Registry and image name for the output container, e.g. my-registry/sample-app-enclaveos:latest

inputAuthConfig
object (AuthConfig)

Credentials for authenticating to a docker registry

username
string

User name for docker registry authentication

password
string

Password for docker registry authentication. Note that this field may be redacted when it appears in API responses.

outputAuthConfig
object (AuthConfig)

Credentials for authenticating to a docker registry

username
string

User name for docker registry authentication

password
string

Password for docker registry authentication. Note that this field may be redacted when it appears in API responses.

authConfig
object (AuthConfig)

Credentials for authenticating to a docker registry

username
string

User name for docker registry authentication

password
string

Password for docker registry authentication. Note that this field may be redacted when it appears in API responses.

isvprodid
integer (int64)

This is the enclave productId.

isvsvn
integer (int64)

This is the enclave security version.

memSize
string

Override the enclave size, e.g. 2048M. Suffixes K, M, and G are supported.

threads
integer (int32)

Number of enclave threads

debug
boolean

Enables debug logging from EnclaveOS

entrypoint
Array of string

Override the entrypoint of the original container

string
entrypointArgs
Array of string

Override additional arguments to the container entrypoint

string
encryptedDirs
Array of string

List of read-write files and/or directories which are encrypted using the enclave sealing key Default encrypted directories - enclave-os protects the content in these files by encrypting them using the enclave sealing key. Anyone is allowed to read from or write to these files but only the enclave application can see it's contents in plain text.

  • /tmp
  • /run
  • /ftx-efs
  • /opt/fortanix/enclave-os/app-config/rw Tips while debugging -> The default encrypted directories visible to the guest application as /tmp, /run and /ftx-efs are available in the container filesystem at /opt/fortanix/enclave-os/default-efs-dirs/.
string
manifestOptions
object

Add additional options to EnclaveOS manifest file

certificates
Array of object (CertificateConfig)
object
issuer
string

Certificate issuance strategy

Valid values[ "MANAGER_CA", "NODE", "SELF_IAS" ]
Default"MANAGER_CA"
subject
string

Certificate subject common name, typically a DNS name

keyType
string

Type of key to generate

Valid values[ "RSA" ]
Default"RSA"
keyParam
object

Key parameters. Currently must be an instance of RsaKeyParam, but other types may be supported in the future.

keyPath
string

Path to expose the key in the application filesystem

certPath
string

Path to expose the certificate in the application filesystem

signingKey
object (SigningKeyConfig)

Configures a key to sign the converted image

default
object (DefaultSigningKeyConfig)

Requests signing the converted image with a default key

sdkms
object (SdkmsSigningKeyConfig)

Configures an SDKMS signing key. The key must be an RSA key with public exponent 3.

name
string

name of the signing key in SDKMS

apiKey
string

API key to authenticate with SDKMS

externalPackages
string

Fortanix external packages mount point in the toolserver container

coreDumpPattern
string

Template for generating debug core dump file paths

logFilePath
string

Path for EnclaveOS log file

javaMode
string
roDirs
Array of string

List of read only directories Default read-only directories - enclave-os protects the integrity of these files and hence only allows these files to be read and not modified.

  • /
  • /opt/fortanix/enclave-os/app-config/ro
string
rwDirs
Array of string

List of read-write files and/or directories Default read-write directories - enclave-os doesn't provide any security measures for these files and anyone is allowed to read from or write to these files.

  • /etc/hosts
  • /etc/resolv.conf
  • /etc/hostname
string
allowCmdlineArgs
boolean

Allow command line arguments to EnclaveOS application

manifestEnv
Array of string

List of manifest environment variables

string
Responses
200

Registry and image name for the output container (same as outputImageName in the request)

object
newImage
string

Registry and image name for the output container (same as outputImageName in the request)

imageSHA
string

Shortened SHA256 Hash of the output image (This is the id of the image)

imageSize
integer

The output image size in bytes

isvprodid
integer

This is the enclave productId which is same as the isvprodid in input request, if set. Default value is 0

isvsvn
integer

This is the enclave security version which is same as the isvsvn in input request, if set. Default value is 0

mrenclave
string

This is the measurement of the enclave which uniquely identifies the shielded application. This is in hex format.

mrenclave2
string

This is the measurement of the enclave which uniquely identifies the shielded application for SGX2. This is in hex format.

mrsigner
string

This is the hash of the signing key which uniquely identifies the signing key. This is in hex format.