annotators

Documentation

Overview

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

Index

• func NewPkiAnnotator(cfg config.SdkInfo) interfaces.Annotator
• func NewSourceAnnotator(cfg config.SdkInfo) interfaces.Annotator
• func NewTlsAnnotator(cfg config.SdkInfo) interfaces.Annotator
• func NewTpmAnnotator(cfg config.SdkInfo) interfaces.Annotator
• type PkiAnnotator
  • func (a *PkiAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)
• type SourceAnnotator
  • func (a *SourceAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)
• type TlsAnnotator
  • func (a *TlsAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)
• type TpmAnnotator
  • func (a *TpmAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)

Functions

func NewPkiAnnotator

func NewPkiAnnotator(cfg config.SdkInfo) interfaces.Annotator

func NewSourceAnnotator

func NewSourceAnnotator(cfg config.SdkInfo) interfaces.Annotator

func NewTlsAnnotator

func NewTlsAnnotator(cfg config.SdkInfo) interfaces.Annotator

func NewTpmAnnotator

func NewTpmAnnotator(cfg config.SdkInfo) interfaces.Annotator

Types

type PkiAnnotator

type PkiAnnotator struct {
	// contains filtered or unexported fields
}

PkiAnnotator is used to validate whether the signature on a given piece of data is valid

func (*PkiAnnotator) Do

func (a *PkiAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)

type SourceAnnotator

type SourceAnnotator struct {
	// contains filtered or unexported fields
}

SourceAnnotator is used to provide lineage from one version of data to another as the result of a change or transformation.

func (*SourceAnnotator) Do

func (a *SourceAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)

type TlsAnnotator

type TlsAnnotator struct {
	// contains filtered or unexported fields
}

func (*TlsAnnotator) Do

func (a *TlsAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)

type TpmAnnotator

type TpmAnnotator struct {
	// contains filtered or unexported fields
}

TpmAnnotator is used to attest whether or not the host machine has TPM capability for managing secrets

func (*TpmAnnotator) Do

func (a *TpmAnnotator) Do(ctx context.Context, data []byte) (contracts.Annotation, error)