Discover modules > github.com/gemaraproj/gemara
v1.5.0
#AuditLog: ¶

AuditLog records results from an audit performed against a target resource

metadata: ¶

metadata provides detailed data about this log

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"AuditLog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

owner?: ¶

owner defines the RACI roles responsible for managing the audit

responsible: [#Contact, ...#Contact] ¶

responsible identifies the entities responsible for executing work to manage or mitigate the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

accountable: [#Contact, ...#Contact] ¶

accountable identifies the entity ultimately accountable for the outcome

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

consulted?: [#Contact, ...#Contact] ¶

consulted identifies entities whose input is required when assessing or responding to the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

informed?: [#Contact, ...#Contact] ¶

informed identifies entities that should be notified about changes to the artifact status

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

summary: string ¶

summary provides the high-level conclusion

criteria: [#ArtifactMapping, ...#ArtifactMapping] ¶

criteria defines the acceptable state for the audited resource

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

results: [#AuditResult, ...#AuditResult] ¶

results records audit results against the criteria

[0]: ¶
id: string ¶

id uniquely identifies this result

title: string ¶

title describes this result at a glance

type: #ResultType ¶

type classifies the nature of this result

description: string ¶

description explains the result in detail

"criteria-reference": ¶

criteria-reference maps this result to specific criteria entries

entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

evidence?: [#Evidence, ...#Evidence] ¶

evidence records the data sources that support this result

[0]: ¶
id: string ¶

id uniquely identifies this evidence

type: #EvidenceType ¶

type categorizes the kind of evidence

"collected-at": #Datetime ¶

collected-at is the timestamp when the evidence was gathered

payload?: _ ¶

payload is the raw evidence data collected inline

source?: ¶

source identifies the artifact or system from which this evidence was collected

"reference-id": string ¶

reference-id ties this evidence to a mapping-reference in the artifact's metadata

coordinate?: string ¶

coordinate is the precise location within the stream identified by reference-id (e.g. an API path, file path, or JSON path expression). Do not set if entry-id is set.

"entry-id"?: string ¶

entry-id identifies a specific entry within a referenced Gemara artifact. Do not set if coordinate is set.

digest?: =~"^[a-z0-9]+(?:[+._-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$" ¶

digest is a cryptographic hash of the observed content at collection time; format: algorithm:encoded (e.g. sha256:abc123...)

remarks?: string ¶

remarks is prose regarding this evidence reference

description?: string ¶

description explains what this evidence represents

recommendations?: [#Recommendation, ...#Recommendation] ¶

recommendations records corrective actions for this result

[0]: ¶
id?: string ¶

id uniquely identifies this recommendation

text: string ¶

text describes the recommended corrective action

required: *false | bool ¶

required indicates whether this recommendation is a mandatory corrective action

target: ¶

target identifies the resource being evaluated

environment?: string ¶

environment describes where the resource exists (e.g., production, staging, development, specific region)

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

owner?: ¶

owner is the contact information for the person or group responsible for managing or owning this resource

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#CapabilityCatalog: ¶

CapabilityCatalog describes a collection of system capabilities

title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"CapabilityCatalog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

capabilities?: [#Capability, ...#Capability] ¶

capabilities is a list of capabilities defined by this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes this capability at a glance

description: string ¶

description provides a detailed overview of this capability

group: string ¶

group references by id a catalog group that this capability belongs to

groups?: [#Group, ...#Group] ¶

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#Capability: ¶

Capability describes a system capability such as a feature, component or object.

id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes this capability at a glance

description: string ¶

description provides a detailed overview of this capability

group: string ¶

group references by id a catalog group that this capability belongs to

#Catalog: ¶

Catalog describes a set of topically-associated entries

title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

groups?: [#Group, ...#Group] ¶

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#ControlCatalog: ¶

ControlCatalog describes a set of related controls and relevant metadata

title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"ControlCatalog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

controls?: [#Control, ...#Control] ¶

controls is a list of unique controls defined by this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this control at a glance

objective: string ¶

objective is a unified statement of intent, which may encompass multiple situationally applicable requirements

group: string ¶

group references by id a catalog group that this control belongs to

"assessment-requirements": [#AssessmentRequirement, ...#AssessmentRequirement] ¶

assessment-requirements is a list of requirements that must be verified to confirm the control objective has been met

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

text: string ¶

text is the body of the requirement, typically written as a MUST condition

applicability: [string, ...string] ¶

applicability is a list of strings describing the situations where this text functions as a requirement for its parent control

[0]: string ¶
recommendation?: string ¶

recommendation provides readers with non-binding suggestions to aid in evaluation or enforcement of the requirement

state: #Lifecycle ¶

state is the lifecycle state of this assessment requirement

"replaced-by"?: ¶

replaced-by references the assessment requirement that supersedes this one when deprecated or retired

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

guidelines?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

guidelines documents relationships between this control and Layer 1 guideline artifacts

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

threats?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

threats documents relationships between this control and Layer 2 threat artifacts

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

state: #Lifecycle ¶

state is the lifecycle state of this control

"replaced-by"?: ¶

replaced-by references the control that supersedes this one when deprecated or retired

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

groups?: [#Group, ...#Group] ¶

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#Control: ¶

Control describes a safeguard or countermeasure with a clear objective and assessment requirements

id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this control at a glance

objective: string ¶

objective is a unified statement of intent, which may encompass multiple situationally applicable requirements

group: string ¶

group references by id a catalog group that this control belongs to

"assessment-requirements": [#AssessmentRequirement, ...#AssessmentRequirement] ¶

assessment-requirements is a list of requirements that must be verified to confirm the control objective has been met

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

text: string ¶

text is the body of the requirement, typically written as a MUST condition

applicability: [string, ...string] ¶

applicability is a list of strings describing the situations where this text functions as a requirement for its parent control

[0]: string ¶
recommendation?: string ¶

recommendation provides readers with non-binding suggestions to aid in evaluation or enforcement of the requirement

state: #Lifecycle ¶

state is the lifecycle state of this assessment requirement

"replaced-by"?: ¶

replaced-by references the assessment requirement that supersedes this one when deprecated or retired

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

guidelines?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

guidelines documents relationships between this control and Layer 1 guideline artifacts

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

threats?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

threats documents relationships between this control and Layer 2 threat artifacts

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

state: #Lifecycle ¶

state is the lifecycle state of this control

"replaced-by"?: ¶

replaced-by references the control that supersedes this one when deprecated or retired

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

#AssessmentRequirement: ¶

AssessmentRequirement describes a tightly scoped, verifiable condition that must be satisfied and confirmed by an evaluator

id: string ¶

id allows this entry to be referenced by other elements

text: string ¶

text is the body of the requirement, typically written as a MUST condition

applicability: [string, ...string] ¶

applicability is a list of strings describing the situations where this text functions as a requirement for its parent control

[0]: string ¶
recommendation?: string ¶

recommendation provides readers with non-binding suggestions to aid in evaluation or enforcement of the requirement

state: #Lifecycle ¶

state is the lifecycle state of this assessment requirement

"replaced-by"?: ¶

replaced-by references the assessment requirement that supersedes this one when deprecated or retired

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

#Datetime: time.Format("2006-01-02T15:04:05Z07:00") ¶

Datetime represents an ISO 8601 formatted datetime string

#EnforcementLog: ¶

EnforcementLog records actions taken in response to noncompliance findings from Layer 5 evaluations.

metadata: ¶

metadata provides detailed data about this log

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"EnforcementLog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

disposition: #Disposition ¶

disposition is the aggregate enforcement disposition across all actions in this log

actions:
click to see definition
[#ActionResult, ...#ActionResult] & [...{
	if disposition == "Clear" {
		justification: assessments: [...{result: "Passed"}]
	}
}]
¶

actions is the list of enforcement actions performed

Enforce that Clear dispositions only contain Passed assessment results

[0]:
click to see definition
#ActionResult &
	{
		{
			if disposition == "Clear" {
				justification: assessments: [...{result: "Passed"}]
			}
		}}
¶
disposition: #Disposition ¶

disposition is the enforcement action taken

method: ¶

method references the specific AcceptedMethod entry within the Policy being enforced

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

message?: string ¶

message provides additional context about the action

start: #Datetime ¶

start is the timestamp when the enforcement action began

end?: #Datetime ¶

end is the timestamp when the enforcement action concluded

steps: [#EnforcementStep, ...#EnforcementStep] ¶

steps references the code paths or addresses that carried out this enforcement action

[0]: #EnforcementStep ¶
justification: ¶

justification links the action to its assessment findings and any applicable exceptions

assessments: [#AssessmentFinding, ...#AssessmentFinding] ¶

assessments links the action to one or more Assessment Findings

[0]: ¶
result: #Result ¶

result is the assessment outcome that triggered the enforcement action

requirement?: ¶

requirement maps to the Layer 2 assessment requirement that was evaluated

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

plan maps to the Policy assessment plan that was executed

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

log: ¶

log maps to the EvaluationLog entry containing the finding

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

exceptions?: [#ArtifactMapping, ...#ArtifactMapping] ¶

exceptions references approved Policy exceptions that authorize the action

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

target: ¶

target identifies the resource being evaluated

environment?: string ¶

environment describes where the resource exists (e.g., production, staging, development, specific region)

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

owner?: ¶

owner is the contact information for the person or group responsible for managing or owning this resource

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#ActionResult: ¶

ActionResult captures a performed enforcement action.

disposition: #Disposition ¶

disposition is the enforcement action taken

method: ¶

method references the specific AcceptedMethod entry within the Policy being enforced

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

message?: string ¶

message provides additional context about the action

start: #Datetime ¶

start is the timestamp when the enforcement action began

end?: #Datetime ¶

end is the timestamp when the enforcement action concluded

steps: [#EnforcementStep, ...#EnforcementStep] ¶

steps references the code paths or addresses that carried out this enforcement action

[0]: #EnforcementStep ¶
justification: ¶

justification links the action to its assessment findings and any applicable exceptions

assessments: [#AssessmentFinding, ...#AssessmentFinding] ¶

assessments links the action to one or more Assessment Findings

[0]: ¶
result: #Result ¶

result is the assessment outcome that triggered the enforcement action

requirement?: ¶

requirement maps to the Layer 2 assessment requirement that was evaluated

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

plan maps to the Policy assessment plan that was executed

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

log: ¶

log maps to the EvaluationLog entry containing the finding

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

exceptions?: [#ArtifactMapping, ...#ArtifactMapping] ¶

exceptions references approved Policy exceptions that authorize the action

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#EnforcementStep: string ¶

EnforcementStep is a reference to the code that performed an enforcement action

#Entity: ¶

Entity represents a human or tool

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#Actor: ¶

Actor represents an entity (human or tool) that performs actions in evaluations

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#EvaluationLog: ¶

EvaluationLog contains the results of evaluating a set of Layer 2 controls.

metadata: ¶

metadata provides detailed data about this log

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"EvaluationLog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

result: #Result ¶

result is the aggregate outcome across all evaluations in this log

evaluations: [#ControlEvaluation, ...#ControlEvaluation] ¶
[0]: ¶
name: string ¶
result: #Result ¶
message: string ¶
control: ¶
"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

"assessment-logs":
click to see definition
[#AssessmentLog, ...#AssessmentLog] & [...{requirement: "reference-id": control."reference-id"}] & [
	#_AssessmentLogStrict,
	...#_AssessmentLogStrict,
]
¶

Enforce that control reference and the assessments' references match This formulation uses the control's reference if the assessment doesn't include a reference

Require start timestamp on assessments that actually executed

[0]: #AssessmentLog & #_AssessmentLogStrict & {requirement: "reference-id": control."reference-id"} ¶
requirement: ¶

Requirement should map to the assessment requirement for this assessment.

"reference-id": control."reference-id" & {string} ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

Plan maps to the policy assessment plan being executed.

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

description: string ¶

Description provides a summary of the assessment procedure.

result: #Result & #Result ¶

Result is the overall outcome of the assessment procedure, matching the result of the last step that was run.

message: string ¶

Message provides additional context about the assessment result.

applicability: [string, ...string] ¶

Applicability is elevated from the Layer 2 Assessment Requirement to aid in execution and reporting.

[0]: string ¶
steps: [#AssessmentStep, ...#AssessmentStep] ¶

Steps are sequential actions taken as part of the assessment, which may halt the assessment if a failure occurs.

[0]: #AssessmentStep ¶
"steps-executed"?: int ¶

Steps-executed is the number of steps that were executed as part of the assessment.

start?: #Datetime ¶

Start is the timestamp when the assessment began. Assessments that never executed have no start time to record.

end?: #Datetime ¶

End is the timestamp when the assessment concluded.

recommendation?: string ¶

Recommendation provides guidance on how to address a failed assessment.

"confidence-level"?: #ConfidenceLevel ¶

ConfidenceLevel indicates the evaluator's confidence level in this specific assessment result.

evidence?: [#Evidence, ...#Evidence] ¶

Evidence records the raw data cited to support this assessment's opinion.

[0]: ¶
id: string ¶

id uniquely identifies this evidence

type: #EvidenceType ¶

type categorizes the kind of evidence

"collected-at": #Datetime ¶

collected-at is the timestamp when the evidence was gathered

payload?: _ ¶

payload is the raw evidence data collected inline

source?: #EvidenceMapping ¶

source identifies the artifact or system from which this evidence was collected

description?: string ¶

description explains what this evidence represents

target: ¶

target identifies the resource being evaluated

environment?: string ¶

environment describes where the resource exists (e.g., production, staging, development, specific region)

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

owner?: ¶

owner is the contact information for the person or group responsible for managing or owning this resource

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#ControlEvaluation: ¶

ControlEvaluation contains the results of evaluating a single Layer 5 control.

name: string ¶
result: #Result ¶
message: string ¶
control: ¶
"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

"assessment-logs":
click to see definition
[#AssessmentLog, ...#AssessmentLog] & [...{requirement: "reference-id": control."reference-id"}] & [
	#_AssessmentLogStrict,
	...#_AssessmentLogStrict,
]
¶

Enforce that control reference and the assessments' references match This formulation uses the control's reference if the assessment doesn't include a reference

Require start timestamp on assessments that actually executed

[0]: #AssessmentLog & #_AssessmentLogStrict & {requirement: "reference-id": control."reference-id"} ¶
requirement: ¶

Requirement should map to the assessment requirement for this assessment.

"reference-id": control."reference-id" & {string} ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

Plan maps to the policy assessment plan being executed.

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

description: string ¶

Description provides a summary of the assessment procedure.

result: #Result & #Result ¶

Result is the overall outcome of the assessment procedure, matching the result of the last step that was run.

message: string ¶

Message provides additional context about the assessment result.

applicability: [string, ...string] ¶

Applicability is elevated from the Layer 2 Assessment Requirement to aid in execution and reporting.

[0]: string ¶
steps: [#AssessmentStep, ...#AssessmentStep] ¶

Steps are sequential actions taken as part of the assessment, which may halt the assessment if a failure occurs.

[0]: #AssessmentStep ¶
"steps-executed"?: int ¶

Steps-executed is the number of steps that were executed as part of the assessment.

start?: #Datetime ¶

Start is the timestamp when the assessment began. Assessments that never executed have no start time to record.

end?: #Datetime ¶

End is the timestamp when the assessment concluded.

recommendation?: string ¶

Recommendation provides guidance on how to address a failed assessment.

"confidence-level"?: #ConfidenceLevel ¶

ConfidenceLevel indicates the evaluator's confidence level in this specific assessment result.

evidence?: [#Evidence, ...#Evidence] ¶

Evidence records the raw data cited to support this assessment's opinion.

[0]: ¶
id: string ¶

id uniquely identifies this evidence

type: #EvidenceType ¶

type categorizes the kind of evidence

"collected-at": #Datetime ¶

collected-at is the timestamp when the evidence was gathered

payload?: _ ¶

payload is the raw evidence data collected inline

source?: ¶

source identifies the artifact or system from which this evidence was collected

"reference-id": string ¶

reference-id ties this evidence to a mapping-reference in the artifact's metadata

coordinate?: string ¶

coordinate is the precise location within the stream identified by reference-id (e.g. an API path, file path, or JSON path expression). Do not set if entry-id is set.

"entry-id"?: string ¶

entry-id identifies a specific entry within a referenced Gemara artifact. Do not set if coordinate is set.

digest?: =~"^[a-z0-9]+(?:[+._-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$" ¶

digest is a cryptographic hash of the observed content at collection time; format: algorithm:encoded (e.g. sha256:abc123...)

remarks?: string ¶

remarks is prose regarding this evidence reference

description?: string ¶

description explains what this evidence represents

#Group: ¶

Group represents a classification or grouping that can be used in different contexts with semantic meaning derived from its usage

id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

#GuidanceCatalog: ¶

GuidanceCatalog represents a concerted documentation effort to help bring about an optimal future without foreknowledge of the implementation details

title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"GuidanceCatalog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

groups?: [#Group, ...#Group] ¶

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

type: #GuidanceType ¶

type categorizes this document based on the intent of its contents

"front-matter"?: string ¶

front-matter provides introductory text for the document to be used during rendering

guidelines?: [#Guideline, ...#Guideline] ¶

guidelines is a list of unique guidelines defined by this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the contents of this guideline

objective: string ¶

objective is a unified statement of intent, which may encompass multiple situationally applicable statements

group: string ¶

group provides an id to the group that this guideline belongs to

recommendations?: [string, ...string] ¶

recommendations is a list of non-binding suggestions to aid in evaluation or enforcement of the guideline

[0]: string ¶
extends?: ¶

extends is an id for a guideline which this guideline adds to, in this document or elsewhere

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

applicability?: [string, ...string] ¶

applicability specifies the contexts in which this guideline applies

[0]: string ¶
rationale?: ¶

rationale provides the context for this guideline

importance: string ¶

importance is an explanation of why this guideline matters

goals: [string, ...string] ¶

goals is a list of outcomes this guideline seeks to achieve

[0]: string ¶
statements?: [#Statement, ...#Statement] ¶

statements is a list of structural sub-requirements within a guideline

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title?: string ¶

title describes the contents of this statement

text: string ¶

text is the body of this statement

recommendations?: [string, ...string] ¶

recommendations is a list of non-binding suggestions to aid in evaluation or enforcement of the statement

[0]: string ¶
principles?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

principles documents the relationship between this guideline and one or more principles

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

vectors?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

vector-mappings documents the relationship between this guideline and one or more vectors

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"see-also"?: [string, ...string] ¶

see-also lists related guideline IDs within the same GuidanceCatalog

[0]: string ¶
state: #Lifecycle ¶

state is the lifecycle state of this guideline

"replaced-by"?: ¶

replaced-by references the guideline that supersedes this one when deprecated or retired

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

exemptions?: [#Exemption, ...#Exemption] ¶

exemptions provides information about situations where this guidance is not applicable

[0]: ¶
description: string ¶

description identifies who or what is exempt from the full guidance

reason: string ¶

reason explains why the exemption is granted

redirect?: ¶

redirect points to alternative guidelines or controls that should be followed instead

entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#GuidanceType: "Standard" | "Regulation" | "Best Practice" | "Framework" ¶

GuidanceType restricts the possible types that a catalog may be listed as

#Exemption: ¶

Exemption describes a single scenario where the catalog is not applicable

description: string ¶

description identifies who or what is exempt from the full guidance

reason: string ¶

reason explains why the exemption is granted

redirect?: ¶

redirect points to alternative guidelines or controls that should be followed instead

entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#Guideline: ¶

Guideline provides explanatory context and recommendations for designing optimal outcomes

id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the contents of this guideline

objective: string ¶

objective is a unified statement of intent, which may encompass multiple situationally applicable statements

group: string ¶

group provides an id to the group that this guideline belongs to

recommendations?: [string, ...string] ¶

recommendations is a list of non-binding suggestions to aid in evaluation or enforcement of the guideline

[0]: string ¶
extends?: ¶

extends is an id for a guideline which this guideline adds to, in this document or elsewhere

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

applicability?: [string, ...string] ¶

applicability specifies the contexts in which this guideline applies

[0]: string ¶
rationale?: ¶

rationale provides the context for this guideline

importance: string ¶

importance is an explanation of why this guideline matters

goals: [string, ...string] ¶

goals is a list of outcomes this guideline seeks to achieve

[0]: string ¶
statements?: [#Statement, ...#Statement] ¶

statements is a list of structural sub-requirements within a guideline

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title?: string ¶

title describes the contents of this statement

text: string ¶

text is the body of this statement

recommendations?: [string, ...string] ¶

recommendations is a list of non-binding suggestions to aid in evaluation or enforcement of the statement

[0]: string ¶
principles?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

principles documents the relationship between this guideline and one or more principles

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

vectors?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

vector-mappings documents the relationship between this guideline and one or more vectors

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"see-also"?: [string, ...string] ¶

see-also lists related guideline IDs within the same GuidanceCatalog

[0]: string ¶
state: #Lifecycle ¶

state is the lifecycle state of this guideline

"replaced-by"?: ¶

replaced-by references the guideline that supersedes this one when deprecated or retired

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

#Justification: ¶

Justification provides the assessment data and exception references that justify an enforcement action.

assessments: [#AssessmentFinding, ...#AssessmentFinding] ¶

assessments links the action to one or more Assessment Findings

[0]: ¶
result: #Result ¶

result is the assessment outcome that triggered the enforcement action

requirement?: ¶

requirement maps to the Layer 2 assessment requirement that was evaluated

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

plan maps to the Policy assessment plan that was executed

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

log: ¶

log maps to the EvaluationLog entry containing the finding

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

exceptions?: [#ArtifactMapping, ...#ArtifactMapping] ¶

exceptions references approved Policy exceptions that authorize the action

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#AssessmentFinding: ¶

AssessmentFinding maps an enforcement action to its originating assessment data across Layer 2, Layer 3, and Layer 5.

result: #Result ¶

result is the assessment outcome that triggered the enforcement action

requirement?: ¶

requirement maps to the Layer 2 assessment requirement that was evaluated

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

plan maps to the Policy assessment plan that was executed

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

log: ¶

log maps to the EvaluationLog entry containing the finding

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

#Disposition: "Undetermined" | "Enforced" | "Tolerated" | "Clear" ¶

Disposition enumerates the possible enforcement outcomes.

#Lexicon: ¶

Lexicon is a controlled vocabulary or glossary artifact referenced by Metadata.lexicon

title: string ¶

title describes the purpose of this lexicon at a glance

metadata: ¶

metadata provides detailed data about this document

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"Lexicon"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

terms: [#LexiconTerm, ...#LexiconTerm] ¶

terms is one or more defined entries for linking and rendering

[0]: ¶
id: string ¶

id allows this entry to be referenced for anchors and tooling

title: string ¶

title is the canonical name of the defined concept

definition: string ¶

definition explains the meaning of the term

synonyms?: [string, ...string] ¶

synonyms lists alternative labels that should resolve to this term for linking

[0]: string ¶
references?: [#LexiconReference, ...#LexiconReference] ¶

references cites external authorities supporting the definition

[0]: ¶
citation: string ¶

citation identifies the source material in prose

url?: =~"^(https?|file)://[^\\s]+$" ¶

url points to supporting material when available

#LexiconTerm: ¶

LexiconTerm is a single definition within a lexicon

id: string ¶

id allows this entry to be referenced for anchors and tooling

title: string ¶

title is the canonical name of the defined concept

definition: string ¶

definition explains the meaning of the term

synonyms?: [string, ...string] ¶

synonyms lists alternative labels that should resolve to this term for linking

[0]: string ¶
references?: [#LexiconReference, ...#LexiconReference] ¶

references cites external authorities supporting the definition

[0]: ¶
citation: string ¶

citation identifies the source material in prose

url?: =~"^(https?|file)://[^\\s]+$" ¶

url points to supporting material when available

#LexiconReference: ¶

LexiconReference cites a source supporting a lexicon definition

citation: string ¶

citation identifies the source material in prose

url?: =~"^(https?|file)://[^\\s]+$" ¶

url points to supporting material when available

#Log: ¶

Log describes a set of recorded entries from a measurement activity

metadata: ¶

metadata provides detailed data about this log

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

target: ¶

target identifies the resource being evaluated

environment?: string ¶

environment describes where the resource exists (e.g., production, staging, development, specific region)

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

owner?: ¶

owner is the contact information for the person or group responsible for managing or owning this resource

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#Lifecycle: *"Active" | "Draft" | "Deprecated" | "Retired" ¶

Lifecycle represents the lifecycle state of a guideline, control, or assessment requirement

#ConfidenceLevel: "Undetermined" | "Low" | "Medium" | "High" ¶

ConfidenceLevel indicates the evaluator's confidence level in an assessment result.

#MappingDocument: ¶

MappingDocument captures the user's intent for how entries in a source artifact relate to entries in a target artifact

title: string ¶

title describes the purpose of this mapping document at a glance

metadata: ¶

metadata provides detailed data about this document

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"MappingDocument"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references": [#MappingReference, ...#MappingReference] & [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"source-reference": ¶

source-reference identifies the artifact being mapped from; must match a mapping-reference id

"entry-type": #EntryType ¶

entry-type identifies the type of atomic unit entries in this direction

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"target-reference": ¶

target-reference identifies the artifact being mapped to; must match a mapping-reference id

"entry-type": #EntryType ¶

entry-type identifies the type of atomic unit entries in this direction

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

mappings: [#_MappingStrict, ...#_MappingStrict] ¶

mappings is one or more atomic relationships between entries in the referenced artifacts

[0]: #_MappingStrict ¶
id: string ¶

id allows this mapping to be referenced by other elements

source: string ¶

source identifies the entry being mapped from by its entry-id

targets?: [#MappingTarget, ...#MappingTarget] ¶

targets identifies the entries being mapped to; absent when relationship is no-match

[0]: ¶
"entry-id": string ¶

entry-id identifies the specific entry in the target artifact

strength?: int & >=1 & <=10 ¶

strength is the author's estimate of how completely the source satisfies this target; range 1-10

"confidence-level"?: #ConfidenceLevel ¶
applicability?: [string, ...string] ¶

applicability constrains the contexts in which this target mapping holds

[0]: string ¶
rationale?: string ¶

rationale explains why this relationship exists for this target

remarks?: string ¶

remarks is general prose regarding this target mapping

relationship: #RelationshipType & #RelationshipType ¶

relationship describes the nature of the mapping between source and all targets

remarks?: string ¶

remarks is general prose regarding this mapping

remarks?: string ¶

remarks is prose regarding this mapping document

#MappingReference: ¶

MappingReference represents a reference to an external document with full metadata.

id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

#ArtifactMapping: ¶

ArtifactMapping represents a mapping to an external artifact or artifact entry

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#Metadata: ¶

Metadata represents common metadata fields shared across all layers

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#ArtifactType:
click to see definition
"CapabilityCatalog" |
	"ControlCatalog" |
	"GuidanceCatalog" |
	"ThreatCatalog" |
	"RiskCatalog" |
	"Policy" |
	"MappingDocument" |
	"Lexicon" |
	"EvaluationLog" |
	"EnforcementLog" |
	"VectorCatalog" |
	"PrincipleCatalog" |
	"AuditLog"
¶

ArtifactType identifies the kind of Gemara artifact for unambiguous parsing

#MultiEntryMapping: ¶

MultiEntryMapping represents a mapping to an external reference with one or more entries.

entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#EntryMapping: ¶

EntryMapping represents how a specific entry maps to a MappingReference.

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

#EvidenceMapping: ¶

EvidenceMapping identifies the source from which evidence was collected. reference-id names the MappingReference; coordinate or entry-id gives specificity within it; digest pins the observed content at collection time.

"reference-id": string ¶

reference-id ties this evidence to a mapping-reference in the artifact's metadata

coordinate?: string ¶

coordinate is the precise location within the stream identified by reference-id (e.g. an API path, file path, or JSON path expression). Do not set if entry-id is set.

"entry-id"?: string ¶

entry-id identifies a specific entry within a referenced Gemara artifact. Do not set if coordinate is set.

digest?: =~"^[a-z0-9]+(?:[+._-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$" ¶

digest is a cryptographic hash of the observed content at collection time; format: algorithm:encoded (e.g. sha256:abc123...)

remarks?: string ¶

remarks is prose regarding this evidence reference

#Policy: ¶

Policy represents a policy document with metadata, contacts, scope, imports, implementation plan, risks, and adherence requirements.

title: string ¶
metadata: ¶
id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"Policy"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

contacts: ¶
responsible: [#Contact, ...#Contact] ¶

responsible identifies the entities responsible for executing work to manage or mitigate the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

accountable: [#Contact, ...#Contact] ¶

accountable identifies the entity ultimately accountable for the outcome

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

consulted?: [#Contact, ...#Contact] ¶

consulted identifies entities whose input is required when assessing or responding to the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

informed?: [#Contact, ...#Contact] ¶

informed identifies entities that should be notified about changes to the artifact status

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

scope: ¶
in: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
out?: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
imports: ¶
policies?: [#ArtifactMapping, ...#ArtifactMapping] ¶
[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

catalogs?: [#CatalogImport, ...#CatalogImport] ¶
[0]: ¶
"reference-id": string ¶
exclusions?: [string, ...string] ¶
[0]: string ¶
constraints?: [#Constraint, ...#Constraint] ¶
[0]: ¶
id: string ¶

Unique ID for this constraint to enable Layer 5/6 tracking

"target-id": string ¶

Links to the specific Guidance or Control being constrained

text: string ¶

The prescriptive requirement/constraint text

"assessment-requirement-modifications"?: [#AssessmentRequirementModifier, ...#AssessmentRequirementModifier] ¶
[0]: ¶
id: string ¶
"target-id": string ¶
"modification-type": #ModType ¶
"modification-rationale": string ¶
text?: string ¶

The updated text of the assessment requirement

applicability?: [string, ...string] ¶

The updated applicability of the assessment requirement

[0]: string ¶
recommendation?: string ¶

The updated recommendation for the assessment requirement

guidance?: [#GuidanceImport, ...#GuidanceImport] ¶
[0]: ¶
"reference-id": string ¶
exclusions?: [string, ...string] ¶
[0]: string ¶
constraints?: [#Constraint, ...#Constraint] ¶

Constraints allow policy authors to define ad hoc minimum requirements (e.g., "review at least annually").

[0]: ¶
id: string ¶

Unique ID for this constraint to enable Layer 5/6 tracking

"target-id": string ¶

Links to the specific Guidance or Control being constrained

text: string ¶

The prescriptive requirement/constraint text

"implementation-plan"?: ¶
"notification-process"?: string ¶
"evaluation-timeline": ¶
start: #Datetime ¶
end?: #Datetime ¶
notes: string ¶
"enforcement-timeline": ¶
start: #Datetime ¶
end?: #Datetime ¶
notes: string ¶
risks?: ¶
mitigated?: [#MitigatedRisk, ...#MitigatedRisk] ¶

Mitigated risks only need reference-id and risk-id (no justification required)

[0]: ¶
id: string ¶

id allows this mitigated risk entry to be referenced by accepted risks

risk: ¶

risk references the risk being mitigated

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

accepted?: [#AcceptedRisk, ...#AcceptedRisk] ¶

Accepted risks require rationale (justification) and may include scope. Controls addressing these risks are implicitly identified through threat mappings.

[0]: ¶
id: string ¶

id allows this accepted risk entry to be referenced

"target-id"?: string ¶

target-id optionally links this acceptance to a mitigated risk entry

risk: ¶

risk references the risk being accepted

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

scope?: ¶

scope defines where the risk acceptance applies

in: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
out?: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
justification?: string ¶

justification explains why the risk is accepted

adherence: ¶
"evaluation-methods"?: [#AcceptedMethod & {type: #EvaluationMethodType}, ...#AcceptedMethod & {type: #EvaluationMethodType}] ¶
[0]: ¶
id: string ¶
type: #EvaluationMethodType & #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"assessment-plans"?: [#AssessmentPlan, ...#AssessmentPlan] ¶
[0]: ¶
id: string ¶
"requirement-id": string ¶
frequency: string ¶
"evaluation-methods": [#AcceptedMethod & {type: #EvaluationMethodType}, ...#AcceptedMethod & {type: #EvaluationMethodType}] ¶
[0]: ¶
id: string ¶
type: #EvaluationMethodType & #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: #Contact ¶

contact is contact information for the actor

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"evidence-requirements"?: string ¶
parameters?: [#Parameter, ...#Parameter] ¶
[0]: ¶
id: string ¶
label: string ¶
description: string ¶
"accepted-values"?: [string, ...string] ¶
[0]: string ¶
"enforcement-methods"?: [#AcceptedMethod & {type: #EnforcementMethodType}, ...#AcceptedMethod & {type: #EnforcementMethodType}] ¶
[0]: ¶
id: string ¶
type: #EnforcementMethodType & #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"non-compliance"?: string ¶
#PrincipleCatalog: ¶

PrincipleCatalog describes a set of related principles and relevant metadata

title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"PrincipleCatalog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

groups?: [#Group, ...#Group] ¶

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

principles?: [#Principle, ...#Principle] ¶

principles is a list of unique principles defined by this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the principle at a glance

description: string ¶

description explains the principle and its expected outcomes

group: string ¶

group references by id a catalog group that this principle belongs to

rationale?: string ¶

rationale provides the context for this principle

#Principle: ¶

Principle represents a foundational value or tenet that guides governance, design, and operational decisions

id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the principle at a glance

description: string ¶

description explains the principle and its expected outcomes

group: string ¶

group references by id a catalog group that this principle belongs to

rationale?: string ¶

rationale provides the context for this principle

#Resource: ¶

Resource represents an entity that exists in the system and can be evaluated

environment?: string ¶

environment describes where the resource exists (e.g., production, staging, development, specific region)

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

owner?: ¶

owner is the contact information for the person or group responsible for managing or owning this resource

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#EntityType: "Human" | "Software" | "Software Assisted" ¶

EntityType specifies what entity is interacting in the workflow

#Contact: ¶

Contact is the contact information for a person or group

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

#Email: =~"^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$" ¶

Email represents a validated email address pattern

#RACI: ¶

RACI defines the roles responsible for managing an artifact

responsible: [#Contact, ...#Contact] ¶

responsible identifies the entities responsible for executing work to manage or mitigate the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

accountable: [#Contact, ...#Contact] ¶

accountable identifies the entity ultimately accountable for the outcome

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

consulted?: [#Contact, ...#Contact] ¶

consulted identifies entities whose input is required when assessing or responding to the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

informed?: [#Contact, ...#Contact] ¶

informed identifies entities that should be notified about changes to the artifact status

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

#ResultType: "Gap" | "Finding" | "Observation" | "Strength" ¶

ResultType classifies the nature of an audit result

#AuditResult: ¶

AuditResult records a single result with supporting evidence and recommendations.

id: string ¶

id uniquely identifies this result

title: string ¶

title describes this result at a glance

type: #ResultType ¶

type classifies the nature of this result

description: string ¶

description explains the result in detail

"criteria-reference": ¶

criteria-reference maps this result to specific criteria entries

entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

evidence?: [#Evidence, ...#Evidence] ¶

evidence records the data sources that support this result

[0]: ¶
id: string ¶

id uniquely identifies this evidence

type: #EvidenceType ¶

type categorizes the kind of evidence

"collected-at": #Datetime ¶

collected-at is the timestamp when the evidence was gathered

payload?: _ ¶

payload is the raw evidence data collected inline

source?: ¶

source identifies the artifact or system from which this evidence was collected

"reference-id": string ¶

reference-id ties this evidence to a mapping-reference in the artifact's metadata

coordinate?: string ¶

coordinate is the precise location within the stream identified by reference-id (e.g. an API path, file path, or JSON path expression). Do not set if entry-id is set.

"entry-id"?: string ¶

entry-id identifies a specific entry within a referenced Gemara artifact. Do not set if coordinate is set.

digest?: =~"^[a-z0-9]+(?:[+._-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$" ¶

digest is a cryptographic hash of the observed content at collection time; format: algorithm:encoded (e.g. sha256:abc123...)

remarks?: string ¶

remarks is prose regarding this evidence reference

description?: string ¶

description explains what this evidence represents

recommendations?: [#Recommendation, ...#Recommendation] ¶

recommendations records corrective actions for this result

[0]: ¶
id?: string ¶

id uniquely identifies this recommendation

text: string ¶

text describes the recommended corrective action

required: *false | bool ¶

required indicates whether this recommendation is a mandatory corrective action

#Recommendation: ¶

Recommendation provides a corrective action for an audit result

id?: string ¶

id uniquely identifies this recommendation

text: string ¶

text describes the recommended corrective action

required: *false | bool ¶

required indicates whether this recommendation is a mandatory corrective action

#Evidence: ¶

Evidence records what was cited to support an opinion for a specific activity: raw data for the evaluation layer, evaluation and enforcement artifacts for the audit layer. At least one of payload or source MUST be present; an entry with neither is semantically incomplete.

id: string ¶

id uniquely identifies this evidence

type: #EvidenceType ¶

type categorizes the kind of evidence

"collected-at": #Datetime ¶

collected-at is the timestamp when the evidence was gathered

payload?: _ ¶

payload is the raw evidence data collected inline

source?: ¶

source identifies the artifact or system from which this evidence was collected

"reference-id": string ¶

reference-id ties this evidence to a mapping-reference in the artifact's metadata

coordinate?: string ¶

coordinate is the precise location within the stream identified by reference-id (e.g. an API path, file path, or JSON path expression). Do not set if entry-id is set.

"entry-id"?: string ¶

entry-id identifies a specific entry within a referenced Gemara artifact. Do not set if coordinate is set.

digest?: =~"^[a-z0-9]+(?:[+._-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$" ¶

digest is a cryptographic hash of the observed content at collection time; format: algorithm:encoded (e.g. sha256:abc123...)

remarks?: string ¶

remarks is prose regarding this evidence reference

description?: string ¶

description explains what this evidence represents

#EvidenceType: #ArtifactType | string ¶

EvidenceType categorizes the kind of evidence. It remains an open enum: recommended values include artifact types already known to Gemara (e.g. EvaluationLog, EnforcementLog) plus categories for common evidence forms.

#RiskCatalog: ¶

A RiskCatalog is a structured collection of documented risks that may affect an organization, system, or service. It provides a centralized reference for risks that can be mapped to threats and referenced by policies when documenting how those risks are mitigated or accepted.

title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"RiskCatalog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

groups?: [#RiskCategory, ...#RiskCategory] & [#Group, ...#Group] ¶

groups narrows the base groups to risk categories with appetite and severity boundaries

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

appetite: #RiskAppetite ¶

appetite defines the acceptable level of risk for this category

"max-severity"?: #Severity ¶

max-severity defines the risk tolerance boundary: the highest severity the organization will accept within this category

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

risks?: [#Risk, ...#Risk] ¶

risks is a list of risks defined by this catalog

[0]: ¶
id: string ¶

id allows this risk to be referenced by other elements

title: string ¶

title describes the risk

description: string ¶

description explains the risk scenario

group: string ¶

group references by id a catalog group that this risk belongs to

severity: #Severity ¶

severity describes the assessed level of this risk

rank?: int ¶

rank optionally orders risks for the same catalog (e.g. when several share the same severity). Lower values mean higher relative importance. Omitted when the four severity levels are enough. When set, each value must be unique among all risks in the catalog that specify rank.

owner?: ¶

owner defines the RACI roles responsible for managing this risk

responsible: [#Contact, ...#Contact] ¶

responsible identifies the entities responsible for executing work to manage or mitigate the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

accountable: [#Contact, ...#Contact] ¶

accountable identifies the entity ultimately accountable for the outcome

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

consulted?: [#Contact, ...#Contact] ¶

consulted identifies entities whose input is required when assessing or responding to the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

informed?: [#Contact, ...#Contact] ¶

informed identifies entities that should be notified about changes to the artifact status

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

impact?: string ¶

impact describes the business or operational impact

threats?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

threats link this risk to Layer 2 threats

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#RiskCategory: ¶

RiskCategory describes a grouping of risks and defines appetite boundaries

appetite: #RiskAppetite ¶

appetite defines the acceptable level of risk for this category

id: string ¶

id allows this entry to be referenced by other elements

"max-severity"?: #Severity ¶

max-severity defines the risk tolerance boundary: the highest severity the organization will accept within this category

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

#Scope: ¶

Scope defines what is included and excluded from policy applicability.

in: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
out?: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
#Dimensions: ¶

Dimensions specify the applicability criteria for a policy

technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
#Imports: ¶

Imports defines external policies, controls, and guidelines required by this policy.

policies?: [#ArtifactMapping, ...#ArtifactMapping] ¶
[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

catalogs?: [#CatalogImport, ...#CatalogImport] ¶
[0]: ¶
"reference-id": string ¶
exclusions?: [string, ...string] ¶
[0]: string ¶
constraints?: [#Constraint, ...#Constraint] ¶
[0]: ¶
id: string ¶

Unique ID for this constraint to enable Layer 5/6 tracking

"target-id": string ¶

Links to the specific Guidance or Control being constrained

text: string ¶

The prescriptive requirement/constraint text

"assessment-requirement-modifications"?: [#AssessmentRequirementModifier, ...#AssessmentRequirementModifier] ¶
[0]: ¶
id: string ¶
"target-id": string ¶
"modification-type": #ModType ¶
"modification-rationale": string ¶
text?: string ¶

The updated text of the assessment requirement

applicability?: [string, ...string] ¶

The updated applicability of the assessment requirement

[0]: string ¶
recommendation?: string ¶

The updated recommendation for the assessment requirement

guidance?: [#GuidanceImport, ...#GuidanceImport] ¶
[0]: ¶
"reference-id": string ¶
exclusions?: [string, ...string] ¶
[0]: string ¶
constraints?: [#Constraint, ...#Constraint] ¶

Constraints allow policy authors to define ad hoc minimum requirements (e.g., "review at least annually").

[0]: ¶
id: string ¶

Unique ID for this constraint to enable Layer 5/6 tracking

"target-id": string ¶

Links to the specific Guidance or Control being constrained

text: string ¶

The prescriptive requirement/constraint text

#ImplementationPlan: ¶

ImplementationPlan defines when and how the policy becomes active.

"notification-process"?: string ¶
"evaluation-timeline": ¶
start: #Datetime ¶
end?: #Datetime ¶
notes: string ¶
"enforcement-timeline": ¶
start: #Datetime ¶
end?: #Datetime ¶
notes: string ¶
#ImplementationDetails: ¶

ImplementationDetails specifies the timeline for policy implementation.

start: #Datetime ¶
end?: #Datetime ¶
notes: string ¶
#Risks: ¶

Risks defines mitigated and accepted risks addressed by this policy.

mitigated?: [#MitigatedRisk, ...#MitigatedRisk] ¶

Mitigated risks only need reference-id and risk-id (no justification required)

[0]: ¶
id: string ¶

id allows this mitigated risk entry to be referenced by accepted risks

risk: ¶

risk references the risk being mitigated

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

accepted?: [#AcceptedRisk, ...#AcceptedRisk] ¶

Accepted risks require rationale (justification) and may include scope. Controls addressing these risks are implicitly identified through threat mappings.

[0]: ¶
id: string ¶

id allows this accepted risk entry to be referenced

"target-id"?: string ¶

target-id optionally links this acceptance to a mitigated risk entry

risk: ¶

risk references the risk being accepted

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

scope?: ¶

scope defines where the risk acceptance applies

in: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
out?: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
justification?: string ¶

justification explains why the risk is accepted

#MitigatedRisk: ¶

MitigatedRisk represents a risk addressed by the policy

id: string ¶

id allows this mitigated risk entry to be referenced by accepted risks

risk: ¶

risk references the risk being mitigated

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

#AcceptedRisk: ¶

AcceptedRisk documents a risk the organization has chosen to accept, optionally linking it to a mitigated risk when the acceptance covers residual risk after partial mitigation.

id: string ¶

id allows this accepted risk entry to be referenced

"target-id"?: string ¶

target-id optionally links this acceptance to a mitigated risk entry

risk: ¶

risk references the risk being accepted

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

scope?: ¶

scope defines where the risk acceptance applies

in: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
out?: ¶
technologies?: [string, ...string] ¶

technologies is an optional list of technology categories or services

[0]: string ¶
geopolitical?: [string, ...string] ¶

geopolitical is an optional list of geopolitical regions

[0]: string ¶
sensitivity?: [string, ...string] ¶

sensitivity is an optional list of data classification levels

[0]: string ¶
users?: [string, ...string] ¶

users is an optional list of user roles

[0]: string ¶
groups?: [string, ...string] ¶
[0]: string ¶
justification?: string ¶

justification explains why the risk is accepted

#Adherence: ¶

Adherence defines evaluation methods, assessment plans, enforcement methods, and non-compliance notifications.

"evaluation-methods"?: [#AcceptedMethod & {type: #EvaluationMethodType}, ...#AcceptedMethod & {type: #EvaluationMethodType}] ¶
[0]: ¶
id: string ¶
type: #EvaluationMethodType & #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"assessment-plans"?: [#AssessmentPlan, ...#AssessmentPlan] ¶
[0]: ¶
id: string ¶
"requirement-id": string ¶
frequency: string ¶
"evaluation-methods": [#AcceptedMethod & {type: #EvaluationMethodType}, ...#AcceptedMethod & {type: #EvaluationMethodType}] ¶
[0]: ¶
id: string ¶
type: #EvaluationMethodType & #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"evidence-requirements"?: string ¶
parameters?: [#Parameter, ...#Parameter] ¶
[0]: ¶
id: string ¶
label: string ¶
description: string ¶
"accepted-values"?: [string, ...string] ¶
[0]: string ¶
"enforcement-methods"?: [#AcceptedMethod & {type: #EnforcementMethodType}, ...#AcceptedMethod & {type: #EnforcementMethodType}] ¶
[0]: ¶
id: string ¶
type: #EnforcementMethodType & #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"non-compliance"?: string ¶
#AssessmentPlan: ¶

AssessmentPlan defines how a specific assessment requirement is evaluated.

id: string ¶
"requirement-id": string ¶
frequency: string ¶
"evaluation-methods": [#AcceptedMethod & {type: #EvaluationMethodType}, ...#AcceptedMethod & {type: #EvaluationMethodType}] ¶
[0]: ¶
id: string ¶
type: #EvaluationMethodType & #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"evidence-requirements"?: string ¶
parameters?: [#Parameter, ...#Parameter] ¶
[0]: ¶
id: string ¶
label: string ¶
description: string ¶
"accepted-values"?: [string, ...string] ¶
[0]: string ¶
#AcceptedMethod: ¶

AcceptedMethod defines a method for evaluation or enforcement.

id: string ¶
type: #MethodType ¶
mode: #ModeType ¶
required: *false | bool ¶
description?: string ¶
executor?: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#ModeType: "Manual" | "Automated" ¶
#MethodType: "Behavioral" | "Intent" | "Remediation" | "Gate" ¶
#EvaluationMethodType: "Intent" | "Behavioral" ¶
#EnforcementMethodType: "Gate" | "Remediation" ¶
#Parameter: ¶

Parameter defines a configurable parameter for assessment or enforcement activities.

id: string ¶
label: string ¶
description: string ¶
"accepted-values"?: [string, ...string] ¶
[0]: string ¶
#GuidanceImport: ¶

GuidanceImport defines how to import guidance documents with optional exclusions and constraints.

"reference-id": string ¶
exclusions?: [string, ...string] ¶
[0]: string ¶
constraints?: [#Constraint, ...#Constraint] ¶

Constraints allow policy authors to define ad hoc minimum requirements (e.g., "review at least annually").

[0]: ¶
id: string ¶

Unique ID for this constraint to enable Layer 5/6 tracking

"target-id": string ¶

Links to the specific Guidance or Control being constrained

text: string ¶

The prescriptive requirement/constraint text

#CatalogImport: ¶

CatalogImport defines how to import control catalogs with optional exclusions, constraints, and assessment requirement modifications.

"reference-id": string ¶
exclusions?: [string, ...string] ¶
[0]: string ¶
constraints?: [#Constraint, ...#Constraint] ¶
[0]: ¶
id: string ¶

Unique ID for this constraint to enable Layer 5/6 tracking

"target-id": string ¶

Links to the specific Guidance or Control being constrained

text: string ¶

The prescriptive requirement/constraint text

"assessment-requirement-modifications"?: [#AssessmentRequirementModifier, ...#AssessmentRequirementModifier] ¶
[0]: ¶
id: string ¶
"target-id": string ¶
"modification-type": #ModType ¶
"modification-rationale": string ¶
text?: string ¶

The updated text of the assessment requirement

applicability?: [string, ...string] ¶

The updated applicability of the assessment requirement

[0]: string ¶
recommendation?: string ¶

The updated recommendation for the assessment requirement

#Constraint: ¶

Constraint defines a prescriptive requirement that applies to a specific guidance or control.

id: string ¶

Unique ID for this constraint to enable Layer 5/6 tracking

"target-id": string ¶

Links to the specific Guidance or Control being constrained

text: string ¶

The prescriptive requirement/constraint text

#AssessmentRequirementModifier: ¶

AssessmentRequirementModifier allows organizations to customize assessment requirements based on how an organization wants to gather evidence for the objective.

id: string ¶
"target-id": string ¶
"modification-type": #ModType ¶
"modification-rationale": string ¶
text?: string ¶

The updated text of the assessment requirement

applicability?: [string, ...string] ¶

The updated applicability of the assessment requirement

[0]: string ¶
recommendation?: string ¶

The updated recommendation for the assessment requirement

#ModType: "Add" | "Modify" | "Remove" | "Replace" | "Override" ¶

ModType defines the type of modification to the assessment requirement.

#Severity: "Low" | "Medium" | "High" | "Critical" ¶

Severity defines the assessed level of a risk based on its potential impact and likelihood

#RiskAppetite: "Minimal" | "Low" | "Moderate" | "High" ¶

RiskAppetite defines the acceptable level of exposure for a risk category

#Risk: ¶

A Risk represents the potential for negative impact resulting from one or more threats.

id: string ¶

id allows this risk to be referenced by other elements

title: string ¶

title describes the risk

description: string ¶

description explains the risk scenario

group: string ¶

group references by id a catalog group that this risk belongs to

severity: #Severity ¶

severity describes the assessed level of this risk

rank?: int ¶

rank optionally orders risks for the same catalog (e.g. when several share the same severity). Lower values mean higher relative importance. Omitted when the four severity levels are enough. When set, each value must be unique among all risks in the catalog that specify rank.

owner?: ¶

owner defines the RACI roles responsible for managing this risk

responsible: [#Contact, ...#Contact] ¶

responsible identifies the entities responsible for executing work to manage or mitigate the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

accountable: [#Contact, ...#Contact] ¶

accountable identifies the entity ultimately accountable for the outcome

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

consulted?: [#Contact, ...#Contact] ¶

consulted identifies entities whose input is required when assessing or responding to the artifact

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

informed?: [#Contact, ...#Contact] ¶

informed identifies entities that should be notified about changes to the artifact status

[0]: ¶
name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

impact?: string ¶

impact describes the business or operational impact

threats?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

threats link this risk to Layer 2 threats

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#Statement: ¶

Statement represents a structural sub-requirement within a guideline; They do not increase strictness and all statements within a guideline apply together

id: string ¶

id allows this entry to be referenced by other elements

title?: string ¶

title describes the contents of this statement

text: string ¶

text is the body of this statement

recommendations?: [string, ...string] ¶

recommendations is a list of non-binding suggestions to aid in evaluation or enforcement of the statement

[0]: string ¶
#Rationale: ¶

Rationale provides a structured way to communicate a guideline author's intent

importance: string ¶

importance is an explanation of why this guideline matters

goals: [string, ...string] ¶

goals is a list of outcomes this guideline seeks to achieve

[0]: string ¶
#ThreatCatalog: ¶

ThreatCatalog describes a set of topically-associated threats

title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"ThreatCatalog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

groups?: [#Group, ...#Group] ¶

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

threats?: [#Threat, ...#Threat] ¶

threats is a list of threats defined by this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes this threat at a glance

description: string ¶

description provides a detailed explanation of an opportunity for negative impact

group: string ¶

group references by id a catalog group that this threat belongs to

capabilities: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

capabilities documents the relationship between this threat and a system capability

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

vectors?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

vectors documents the relationship between this threat and one or more vectors

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

actors?: [#Actor, ...#Actor] ¶

actors describes the relevant internal or external threat actors

[0]: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#Threat: ¶

Threat describes a specifically-scoped opportunity for a negative impact to the organization

id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes this threat at a glance

description: string ¶

description provides a detailed explanation of an opportunity for negative impact

group: string ¶

group references by id a catalog group that this threat belongs to

capabilities: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

capabilities documents the relationship between this threat and a system capability

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

vectors?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶

vectors documents the relationship between this threat and one or more vectors

[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

actors?: [#Actor, ...#Actor] ¶

actors describes the relevant internal or external threat actors

[0]: ¶
contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

#TypedMapping: ¶

TypedMapping extends ArtifactMapping with a required entry-type for all entries in this direction

"entry-type": #EntryType ¶

entry-type identifies the type of atomic unit entries in this direction

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

#VectorCatalog: ¶
title: string ¶

title describes the purpose of this catalog at a glance

metadata: ¶

metadata provides detailed data about this catalog

id: string ¶

id allows this entry to be referenced by other elements

type: #ArtifactType & {"VectorCatalog"} ¶

type identifies the kind of Gemara artifact for unambiguous parsing

"gemara-version": string ¶

gemara-version declares which version of the Gemara specification this artifact conforms to

version?: string ¶

version is the version identifier of this artifact

date?: #Datetime ¶

date is the publication or effective date of this artifact

description: string ¶

description provides a high-level summary of the artifact's purpose and scope

author: ¶

author is the person or group primarily responsible for this artifact

contact?: ¶

contact is contact information for the actor

name: string ¶

name is the preferred descriptor for the contact entity

affiliation?: string ¶

affiliation is the organization with which the contact entity is associated, such as a team, school, or employer

email?: #Email ¶

email is the preferred email address to reach the contact

social?: string ¶

social is a social media handle or other profile for the contact, such as GitHub

id: string ¶

id uniquely identifies the entity and allows this entry to be referenced by other elements

name: string ¶

name is the name of the entity

type: #EntityType ¶

type specifies the type of entity interacting in the workflow

version?: string ¶

version is the version of the entity (for tools; if applicable)

description?: string ¶

description provides additional context about the entity

uri?: =~"^https?://[^\\s]+$" ¶

uri is a general URI for the entity information

"mapping-references"?: [#MappingReference, ...#MappingReference] ¶

mapping-references is a list of external documents referenced within this artifact

[0]: ¶
id: string ¶

id identifies this mapping reference within the artifact and, when url is absent, the referenced artifact's metadata.id.

title: string ¶

title describes the purpose of this mapping reference at a glance

version: string ¶

version is the version identifier of the artifact being mapped to

description?: string ¶

description is prose regarding the artifact's purpose or content

url?: =~"^(https?|file)://[^\\s]+$" ¶

url is the path where the artifact may be retrieved; preferably responds with Gemara-compatible YAML/JSON

"applicability-groups"?: [#Group, ...#Group] ¶

applicability-groups is a list of groups used to classify within this artifact to specify scope

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

draft?: bool ¶

draft indicates whether this artifact is a pre-release version; open to modification

lexicon?: ¶

lexicon is a URI pointing to a controlled vocabulary or glossary relevant to this artifact

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

groups?: [#Group, ...#Group] ¶

groups contains a list of groups that can be referenced by entries in this catalog

[0]: ¶
id: string ¶

id allows this entry to be referenced by other elements

title: string ¶

title describes the purpose of this group at a glance

description: string ¶

description explains the significance and traits of entries to this group

extends?: [...#ArtifactMapping] ¶

extends references catalogs that this catalog builds upon

imports?: [#MultiEntryMapping, ...#MultiEntryMapping] ¶
[0]: ¶
entries: [#ArtifactMapping, ...#ArtifactMapping] ¶

entries is a list of mapping entries

[0]: ¶
"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

"reference-id": string ¶

reference-id identifies an element from a MappingReference in the artifact's metadata

remarks?: string ¶

remarks is prose regarding the mapped artifact or the mapping relationship

vectors?: [#Vector, ...#Vector] ¶

vectors is a list of attack vectors documented in this catalog

[0]: ¶
id: string ¶

id allows this vector to be referenced by other elements

title: string ¶

title describes the vector

description: string ¶

description explains how the attack vector works

group: string ¶

group references by id a catalog group that this vector belongs to

applicability?: [string, ...string] ¶

applicability specifies the contexts in which this vector can manifest

[0]: string ¶
#Vector: ¶

A Vector represents a method, pathway, or technique through which a threat may be realized or an attack may be carried out.

id: string ¶

id allows this vector to be referenced by other elements

title: string ¶

title describes the vector

description: string ¶

description explains how the attack vector works

group: string ¶

group references by id a catalog group that this vector belongs to

applicability?: [string, ...string] ¶

applicability specifies the contexts in which this vector can manifest

[0]: string ¶
#_AssessmentLogStrict:
click to see definition
#AssessmentLog &
	{
		@go(-)
		{
			result: #Result
			if result != "Not Run" && result != "Unknown" && result != "Not Applicable" {
				start: #Datetime
			}
		}
	}
¶

_AssessmentLogStrict layers the "start required unless unexecuted" rule on top of #AssessmentLog

requirement: ¶

Requirement should map to the assessment requirement for this assessment.

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

Plan maps to the policy assessment plan being executed.

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

description: string ¶

Description provides a summary of the assessment procedure.

result: #Result & #Result ¶

Result is the overall outcome of the assessment procedure, matching the result of the last step that was run.

message: string ¶

Message provides additional context about the assessment result.

applicability: [string, ...string] ¶

Applicability is elevated from the Layer 2 Assessment Requirement to aid in execution and reporting.

[0]: string ¶
steps: [#AssessmentStep, ...#AssessmentStep] ¶

Steps are sequential actions taken as part of the assessment, which may halt the assessment if a failure occurs.

[0]: #AssessmentStep ¶
"steps-executed"?: int ¶

Steps-executed is the number of steps that were executed as part of the assessment.

start?: #Datetime ¶

Start is the timestamp when the assessment began. Assessments that never executed have no start time to record.

end?: #Datetime ¶

End is the timestamp when the assessment concluded.

recommendation?: string ¶

Recommendation provides guidance on how to address a failed assessment.

"confidence-level"?: #ConfidenceLevel ¶

ConfidenceLevel indicates the evaluator's confidence level in this specific assessment result.

evidence?: [#Evidence, ...#Evidence] ¶

Evidence records the raw data cited to support this assessment's opinion.

[0]: ¶
id: string ¶

id uniquely identifies this evidence

type: #EvidenceType ¶

type categorizes the kind of evidence

"collected-at": #Datetime ¶

collected-at is the timestamp when the evidence was gathered

payload?: _ ¶

payload is the raw evidence data collected inline

source?: ¶

source identifies the artifact or system from which this evidence was collected

"reference-id": string ¶

reference-id ties this evidence to a mapping-reference in the artifact's metadata

coordinate?: string ¶

coordinate is the precise location within the stream identified by reference-id (e.g. an API path, file path, or JSON path expression). Do not set if entry-id is set.

"entry-id"?: string ¶

entry-id identifies a specific entry within a referenced Gemara artifact. Do not set if coordinate is set.

digest?: =~"^[a-z0-9]+(?:[+._-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$" ¶

digest is a cryptographic hash of the observed content at collection time; format: algorithm:encoded (e.g. sha256:abc123...)

remarks?: string ¶

remarks is prose regarding this evidence reference

description?: string ¶

description explains what this evidence represents

#AssessmentLog: ¶

AssessmentLog contains the results of executing a single assessment procedure for a control requirement.

requirement: ¶

Requirement should map to the assessment requirement for this assessment.

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

plan?: ¶

Plan maps to the policy assessment plan being executed.

"reference-id": string ¶

reference-id is the id for a MappingReference entry in the artifact's metadata

"entry-id": string ¶

entry-id is the identifier being mapped to in the referenced artifact

remarks?: string ¶

remarks is prose describing the mapping relationship

description: string ¶

Description provides a summary of the assessment procedure.

result: #Result ¶

Result is the overall outcome of the assessment procedure, matching the result of the last step that was run.

message: string ¶

Message provides additional context about the assessment result.

applicability: [string, ...string] ¶

Applicability is elevated from the Layer 2 Assessment Requirement to aid in execution and reporting.

[0]: string ¶
steps: [#AssessmentStep, ...#AssessmentStep] ¶

Steps are sequential actions taken as part of the assessment, which may halt the assessment if a failure occurs.

[0]: #AssessmentStep ¶
"steps-executed"?: int ¶

Steps-executed is the number of steps that were executed as part of the assessment.

start?: #Datetime ¶

Start is the timestamp when the assessment began. Assessments that never executed have no start time to record.

end?: #Datetime ¶

End is the timestamp when the assessment concluded.

recommendation?: string ¶

Recommendation provides guidance on how to address a failed assessment.

"confidence-level"?: #ConfidenceLevel ¶

ConfidenceLevel indicates the evaluator's confidence level in this specific assessment result.

evidence?: [#Evidence, ...#Evidence] ¶

Evidence records the raw data cited to support this assessment's opinion.

[0]: ¶
id: string ¶

id uniquely identifies this evidence

type: #EvidenceType ¶

type categorizes the kind of evidence

"collected-at": #Datetime ¶

collected-at is the timestamp when the evidence was gathered

payload?: _ ¶

payload is the raw evidence data collected inline

source?: ¶

source identifies the artifact or system from which this evidence was collected

"reference-id": string ¶

reference-id ties this evidence to a mapping-reference in the artifact's metadata

coordinate?: string ¶

coordinate is the precise location within the stream identified by reference-id (e.g. an API path, file path, or JSON path expression). Do not set if entry-id is set.

"entry-id"?: string ¶

entry-id identifies a specific entry within a referenced Gemara artifact. Do not set if coordinate is set.

digest?: =~"^[a-z0-9]+(?:[+._-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$" ¶

digest is a cryptographic hash of the observed content at collection time; format: algorithm:encoded (e.g. sha256:abc123...)

remarks?: string ¶

remarks is prose regarding this evidence reference

description?: string ¶

description explains what this evidence represents

#AssessmentStep: string ¶
#Result: "Not Run" | "Passed" | "Failed" | "Needs Review" | "Not Applicable" | "Unknown" ¶
#_MappingStrict:
click to see definition
#Mapping &
	{
		@go(-)
		{
			relationship: #RelationshipType
			if relationship != "no-match" {
				targets: [#MappingTarget, ...#MappingTarget]
			}
		}
	}
¶

_MappingStrict layers the "targets required when not no-match" rule on top of #Mapping

id: string ¶

id allows this mapping to be referenced by other elements

source: string ¶

source identifies the entry being mapped from by its entry-id

targets?: [#MappingTarget, ...#MappingTarget] ¶

targets identifies the entries being mapped to; absent when relationship is no-match

[0]: ¶
"entry-id": string ¶

entry-id identifies the specific entry in the target artifact

strength?: int & >=1 & <=10 ¶

strength is the author's estimate of how completely the source satisfies this target; range 1-10

"confidence-level"?: #ConfidenceLevel ¶
applicability?: [string, ...string] ¶

applicability constrains the contexts in which this target mapping holds

[0]: string ¶
rationale?: string ¶

rationale explains why this relationship exists for this target

remarks?: string ¶

remarks is general prose regarding this target mapping

relationship: #RelationshipType & #RelationshipType ¶

relationship describes the nature of the mapping between source and all targets

remarks?: string ¶

remarks is general prose regarding this mapping

#MappingTarget: ¶

MappingTarget identifies a target entry with optional per-target metadata

"entry-id": string ¶

entry-id identifies the specific entry in the target artifact

strength?: int & >=1 & <=10 ¶

strength is the author's estimate of how completely the source satisfies this target; range 1-10

"confidence-level"?: #ConfidenceLevel ¶
applicability?: [string, ...string] ¶

applicability constrains the contexts in which this target mapping holds

[0]: string ¶
rationale?: string ¶

rationale explains why this relationship exists for this target

remarks?: string ¶

remarks is general prose regarding this target mapping

#Mapping: ¶

Mapping represents a relationship between a source entry and one or more target entries

id: string ¶

id allows this mapping to be referenced by other elements

source: string ¶

source identifies the entry being mapped from by its entry-id

targets?: [#MappingTarget, ...#MappingTarget] ¶

targets identifies the entries being mapped to; absent when relationship is no-match

[0]: ¶
"entry-id": string ¶

entry-id identifies the specific entry in the target artifact

strength?: int & >=1 & <=10 ¶

strength is the author's estimate of how completely the source satisfies this target; range 1-10

"confidence-level"?: #ConfidenceLevel ¶
applicability?: [string, ...string] ¶

applicability constrains the contexts in which this target mapping holds

[0]: string ¶
rationale?: string ¶

rationale explains why this relationship exists for this target

remarks?: string ¶

remarks is general prose regarding this target mapping

relationship: #RelationshipType ¶

relationship describes the nature of the mapping between source and all targets

remarks?: string ¶

remarks is general prose regarding this mapping

#RelationshipType: "implements" | "implemented-by" | "supports" | "supported-by" | "equivalent" | "subsumes" | "no-match" | "relates-to" ¶

RelationshipType enumerates the nature of the mapping between entries.

#EntryType:
click to see definition
"Guideline" |
	"Statement" |
	"Control" |
	"AssessmentRequirement" |
	"Capability" |
	"Threat" |
	"Risk" |
	"Vector" |
	"Principle"
¶

EntryType enumerates the atomic units within Gemara artifacts that can participate in mappings

Source files

  • auditlog.cue
  • capabilitycatalog.cue
  • collections.cue
  • controlcatalog.cue
  • enforcementlog.cue
  • entities.cue
  • evaluationlog.cue
  • guidancecatalog.cue
  • lexicon.cue
  • mapping_inline.cue
  • mappingdocument.cue
  • metadata.cue
  • policy.cue
  • principlecatalog.cue
  • riskcatalog.cue
  • threatcatalog.cue
  • vectorcatalog.cue