Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

go/runtime/bundle: Add expected enclave identity to manifest #5931

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changelog/5931.feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
go/runtime/bundle: Add expected enclave identity to manifest
35 changes: 31 additions & 4 deletions go/runtime/bundle/bundle.go
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,33 @@ func (bnd *Bundle) MrSigner(id component.ID) (*sgx.MrSigner, error) {
return &mrSigner, nil
}

// EnclaveIdentity returns the SGX enclave identity of the given component.
// EnclaveIdentity returns the enclave identity of the given component.
//
// Deprecated: Use EnclaveIdentities instead.
func (bnd *Bundle) EnclaveIdentity(id component.ID) (*sgx.EnclaveIdentity, error) {
ids, err := bnd.EnclaveIdentities(id)
if err != nil {
return nil, err
}
return &ids[0], nil
}

// EnclaveIdentities returns the enclave identities of the given component.
func (bnd *Bundle) EnclaveIdentities(id component.ID) ([]sgx.EnclaveIdentity, error) {
// If the component has a build-time known expected identity, use it.
comp := bnd.Manifest.GetComponentByID(id)
if comp == nil {
return nil, fmt.Errorf("runtime/bundle: component '%s' not available", id)
}
if len(comp.Identities) > 0 {
ids := make([]sgx.EnclaveIdentity, 0, len(comp.Identities))
peternose marked this conversation as resolved.
Show resolved Hide resolved
for _, id := range comp.Identities {
ids = append(ids, id.Enclave)
}
return ids, nil
}

// When not available, recompute at runtime (only supported for SGX).
mrEnclave, err := bnd.MrEnclave(id)
if err != nil {
return nil, err
Expand All @@ -231,9 +256,11 @@ func (bnd *Bundle) EnclaveIdentity(id component.ID) (*sgx.EnclaveIdentity, error
return nil, err
}

return &sgx.EnclaveIdentity{
MrEnclave: *mrEnclave,
MrSigner: *mrSigner,
return []sgx.EnclaveIdentity{
{
MrEnclave: *mrEnclave,
MrSigner: *mrSigner,
},
}, nil
}

Expand Down
17 changes: 17 additions & 0 deletions go/runtime/bundle/bundle_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/stretchr/testify/require"

"github.com/oasisprotocol/oasis-core/go/common"
"github.com/oasisprotocol/oasis-core/go/common/sgx"
"github.com/oasisprotocol/oasis-core/go/runtime/bundle/component"
)

Expand Down Expand Up @@ -40,6 +41,15 @@ func TestBundle(t *testing.T) {
SGX: &SGXMetadata{
Executable: "runtime.sgx",
},
Identities: []Identity{
{
Hypervisor: "test",
Enclave: sgx.EnclaveIdentity{
MrSigner: sgx.MrSigner{0x01},
MrEnclave: sgx.MrEnclave{0x02},
},
},
},
},
},
}
Expand Down Expand Up @@ -77,6 +87,13 @@ func TestBundle(t *testing.T) {
delete(bundle2.Data, manifestName)

ensureBundlesEqual(t, bundle, bundle2, "opened bundle mismatch")

// Test enclave identity is correct.
eids, err := bundle2.EnclaveIdentities(component.ID_RONL)
require.NoError(t, err, "EnclaveIdentities")
require.Len(t, eids, 1)
require.Equal(t, "0100000000000000000000000000000000000000000000000000000000000000", eids[0].MrSigner.String())
require.Equal(t, "0200000000000000000000000000000000000000000000000000000000000000", eids[0].MrEnclave.String())
})

t.Run("ResetManifest", func(t *testing.T) {
Expand Down
17 changes: 17 additions & 0 deletions go/runtime/bundle/manifest.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (

"github.com/oasisprotocol/oasis-core/go/common"
"github.com/oasisprotocol/oasis-core/go/common/crypto/hash"
"github.com/oasisprotocol/oasis-core/go/common/sgx"
"github.com/oasisprotocol/oasis-core/go/common/version"
"github.com/oasisprotocol/oasis-core/go/runtime/bundle/component"
)
Expand Down Expand Up @@ -214,6 +215,15 @@ func (r *TDXResources) Validate() error {
return nil
}

// Identity is the cryptographic identity of a component.
type Identity struct {
// Hypervisor is the optional hypervisor this identity is for.
Hypervisor string `json:"hypervisor,omitempty"`

// Enclave is the enclave identity.
Enclave sgx.EnclaveIdentity `json:"enclave"`
}

// Component is a runtime component.
type Component struct {
// Kind is the component kind.
Expand All @@ -232,6 +242,13 @@ type Component struct {
// TDX is the TDX specific manifest metadata if any.
TDX *TDXMetadata `json:"tdx,omitempty"`

// Identities are the (optional) expected enclave identities. When not provided, it must be
// computed at runtime. In the future, this field will become required.
//
// Multiple identities may be provided because they can differ across different deployment
// systems (e.g. hypervisors).
Identities []Identity `json:"identity,omitempty"`

// Disabled specifies whether the component is disabled by default and needs to be explicitly
// enabled via node configuration to be used.
Disabled bool `json:"disabled,omitempty"`
Expand Down
Loading