xref: /openbmc/bmcweb/redfish-core/schema/dmtf/csdl/Key_v1.xml (revision f2a8e57e)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  Key v1.4.1                                                          -->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2024 DMTF.                                                            -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################       -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
    <edmx:Include Namespace="Resource.v1_0_0"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
  </edmx:Reference>

  <edmx:DataServices>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Language" String="en"/>

      <EntityType Name="Key" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="The `Key` schema describes sensitive data for accessing devices or services."/>
        <Annotation Term="OData.LongDescription" String="This resource shall represent a key for a Redfish implementation."/>
        <Annotation Term="Capabilities.InsertRestrictions">
          <Record>
            <PropertyValue Property="Insertable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.UpdateRestrictions">
          <Record>
            <PropertyValue Property="Updatable" Bool="true"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.DeleteRestrictions">
          <Record>
            <PropertyValue Property="Deletable" Bool="true"/>
          </Record>
        </Annotation>
        <Annotation Term="Redfish.Uris">
          <Collection>
            <String>/redfish/v1/KeyService/NVMeoFSecrets/{KeyId}</String>
            <String>/redfish/v1/UpdateService/RemoteServerSSHKeys/{KeyId}</String>
            <String>/redfish/v1/UpdateService/PublicIdentitySSHKey/{KeyId}</String>
            <String>/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Keys/{KeyId}</String>
            <String>/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Keys/{KeyId}</String>
            <String>/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/TrustedPublicHostKeys/{KeyId}</String>
            <String>/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/PresentedPublicHostKey</String>
            <String>/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/PublicIdentityKey</String>
          </Collection>
        </Annotation>
      </EntityType>

      <EnumType Name="SSHKeyType">
        <Annotation Term="Redfish.Revisions">
          <Collection>
            <Record>
              <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
              <PropertyValue Property="Version" String="v1_4_0"/>
            </Record>
          </Collection>
        </Annotation>
        <Member Name="RSA">
          <Annotation Term="OData.Description" String="RSA."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate an RFC4253-defined 'ssh-rsa' key type."/>
        </Member>
        <Member Name="DSA">
          <Annotation Term="OData.Description" String="DSA."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate an RFC4253-defined 'ssh-dss' key type."/>
        </Member>
        <Member Name="ECDSA">
          <Annotation Term="OData.Description" String="ECDSA."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate an RFC5656-defined ECDSA key type."/>
        </Member>
        <Member Name="Ed25519">
          <Annotation Term="OData.Description" String="Ed25519."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate an RFC8709-defined 'ssh-ed25519' key type."/>
        </Member>
      </EnumType>

      <EnumType Name="ECDSACurveType">
        <Annotation Term="Redfish.Revisions">
          <Collection>
            <Record>
              <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
              <PropertyValue Property="Version" String="v1_4_0"/>
            </Record>
          </Collection>
        </Annotation>
        <Member Name="NISTP256">
          <Annotation Term="OData.Description" String="NIST P-256."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistp256' curve in RFC5656."/>
        </Member>
        <Member Name="NISTP384">
          <Annotation Term="OData.Description" String="NIST P-384."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistp384' curve in RFC5656."/>
        </Member>
        <Member Name="NISTP521">
          <Annotation Term="OData.Description" String="NIST P-521."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistp521' curve in RFC5656."/>
        </Member>
        <Member Name="NISTK163">
          <Annotation Term="OData.Description" String="NIST K-163."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistk163' curve in RFC5656."/>
        </Member>
        <Member Name="NISTP192">
          <Annotation Term="OData.Description" String="NIST P-192."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistp192' curve in RFC5656."/>
        </Member>
        <Member Name="NISTP224">
          <Annotation Term="OData.Description" String="NIST P-224."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistp224' curve in RFC5656."/>
        </Member>
        <Member Name="NISTK233">
          <Annotation Term="OData.Description" String="NIST K-233."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistk233' curve in RFC5656."/>
        </Member>
        <Member Name="NISTB233">
          <Annotation Term="OData.Description" String="NIST B-233."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistb233' curve in RFC5656."/>
        </Member>
        <Member Name="NISTK283">
          <Annotation Term="OData.Description" String="NIST K-283."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistk283' curve in RFC5656."/>
        </Member>
        <Member Name="NISTK409">
          <Annotation Term="OData.Description" String="NIST K-409."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistk409' curve in RFC5656."/>
        </Member>
        <Member Name="NISTB409">
          <Annotation Term="OData.Description" String="NIST B-409."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistb409' curve in RFC5656."/>
        </Member>
        <Member Name="NISTT571">
          <Annotation Term="OData.Description" String="NIST T-571."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the 'nistt571' curve in RFC5656."/>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_0_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2021.2"/>

      <EntityType Name="Key" BaseType="Key.Key">
        <Property Name="KeyString" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The string for the key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the key, and the format shall follow the requirements specified by the `KeyType` property value."/>
          <Annotation Term="Redfish.RequiredOnCreate"/>
        </Property>
        <Property Name="KeyType" Type="Key.v1_0_0.KeyType">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The format of the key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the format type for the key."/>
          <Annotation Term="Redfish.RequiredOnCreate"/>
        </Property>
        <Property Name="NVMeoF" Type="Key.v1_0_0.NVMeoF" Nullable="false">
          <Annotation Term="OData.Description" String="NVMe-oF specific properties."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain NVMe-oF specific properties for this key.  This property shall be present if `KeyType` contains the value `NVMeoF`."/>
        </Property>
        <Property Name="Actions" Type="Key.v1_0_0.Actions" Nullable="false">
          <Annotation Term="OData.Description" String="The available actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
        </Property>
      </EntityType>

      <EnumType Name="KeyType">
        <Member Name="NVMeoF">
          <Annotation Term="OData.Description" String="An NVMe-oF key."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the format of the key is defined by one of the NVMe specifications."/>
        </Member>
        <Member Name="SSH">
          <Annotation Term="OData.Description" String="An SSH public key."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the format of the key is defined by one of the SSH public key formats as defined in, but not limited to, RFC4253, RFC4716, or RFC8709."/>
          <Annotation Term="Redfish.Revisions">
            <Collection>
              <Record>
                <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
                <PropertyValue Property="Version" String="v1_1_0"/>
              </Record>
            </Collection>
          </Annotation>
        </Member>
      </EnumType>

      <ComplexType Name="NVMeoF">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="NVMe-oF specific properties."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain NVMe-oF specific properties for a key."/>
        <Property Name="NQN" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The NVMe Qualified Name (NQN) of the host or target subsystem associated with this key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the NVMe Qualified Name (NQN) of the host or target subsystem associated with this key.  The value of this property shall follow the NQN format defined by the NVMe Base Specification."/>
          <Annotation Term="Redfish.RequiredOnCreate"/>
        </Property>
        <Property Name="SecurityProtocolType" Type="Key.v1_0_0.NVMeoFSecurityProtocolType">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The security protocol that this key uses."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the security protocol that this key uses.  The value shall be derived from the contents of the `KeyString` property."/>
        </Property>
        <Property Name="OEMSecurityProtocolType" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The OEM security protocol that this key uses."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the OEM-defined security protocol that this key uses.  The value shall be derived from the contents of the `KeyString` property.  This property shall be present if `SecurityProtocolType` contains the value `OEM`."/>
        </Property>
        <Property Name="SecureHashAllowList" Type="Collection(Key.v1_0_0.NVMeoFSecureHashType)">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The secure hash algorithms allowed with the usage of this key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the secure hash algorithms allowed with the usage of this key.  An empty list or the absence of this property shall indicate any secure hash algorithms are allowed with this key."/>
        </Property>
        <Property Name="HostKeyId" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The identifier of the host key paired with this target key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the value of the `Id` property of the `Key` resource representing the host key paired with this target key.  An empty string shall indicate the key is not paired.  This property shall be absent for host keys."/>
        </Property>
      </ComplexType>

      <EnumType Name="NVMeoFSecurityProtocolType">
        <Annotation Term="OData.Description" String="The NVMe security protocols that a key protects."/>
        <Annotation Term="OData.LongDescription" String="This enumeration shall list the NVMe security protocols that a key protects."/>
        <Member Name="DHHC">
          <Annotation Term="OData.Description" String="Diffie-Hellman Hashed Message Authentication Code Challenge Handshake Authentication Protocol (DH-HMAC-CHAP)."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the Diffie-Hellman Hashed Message Authentication Code Challenge Handshake Authentication Protocol (DH-HMAC-CHAP) as defined by the NVMe Base Specification."/>
        </Member>
        <Member Name="TLS_PSK">
          <Annotation Term="OData.Description" String="Transport Layer Security Pre-Shared Key (TLS PSK)."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate Transport Layer Security Pre-Shared Key (TLS PSK) as defined by the NVMe TCP Transport Specification."/>
        </Member>
        <Member Name="OEM">
          <Annotation Term="OData.Description" String="OEM."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate an OEM-defined security protocol.  The `OEMSecurityProtocolType` property shall contain the specific OEM protocol."/>
        </Member>
      </EnumType>

      <EnumType Name="NVMeoFSecureHashType">
        <Annotation Term="OData.Description" String="The NVMe secure hash algorithms that a key is allowed to use."/>
        <Annotation Term="OData.LongDescription" String="This enumeration shall list the NVMe secure hash algorithms that a key is allowed to use."/>
        <Member Name="SHA256">
          <Annotation Term="OData.Description" String="SHA-256."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the SHA-256 hash function as defined by the 'DH-HMAC-CHAP hash function identifiers' figure in the NVMe Base Specification."/>
        </Member>
        <Member Name="SHA384">
          <Annotation Term="OData.Description" String="SHA-384."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the SHA-384 hash function as defined by the 'DH-HMAC-CHAP hash function identifiers' figure in the NVMe Base Specification."/>
        </Member>
        <Member Name="SHA512">
          <Annotation Term="OData.Description" String="SHA-512."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the SHA-512 hash function as defined by the 'DH-HMAC-CHAP hash function identifiers' figure in the NVMe Base Specification."/>
        </Member>
      </EnumType>

      <ComplexType Name="Actions">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The available actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
        <Property Name="Oem" Type="Key.v1_0_0.OemActions" Nullable="false">
          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
        </Property>
      </ComplexType>

      <ComplexType Name="OemActions">
        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_0_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="Key" BaseType="Key.v1_0_0.Key"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_1_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2022.1"/>
      <Annotation Term="OData.Description" String="This version was created to add `SSH` to `KeyType`."/>

      <EntityType Name="Key" BaseType="Key.v1_0_0.Key">
        <Property Name="UserDescription" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="A user-defined string to describe this key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a user-provided string that describes the key."/>
        </Property>
      </EntityType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_1_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="Key" BaseType="Key.v1_1_0.Key"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_2_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2022.3"/>

      <EntityType Name="Key" BaseType="Key.v1_1_0.Key">
        <Property Name="SSH" Type="Key.v1_2_0.SSHType" Nullable="false">
          <Annotation Term="OData.Description" String="SSH specific properties."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain SSH specific properties for this key.  This property shall be present if `KeyType` contains the value `SSH`."/>
        </Property>
      </EntityType>

      <ComplexType Name="SSHType">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="SSH specific properties."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain SSH specific properties for a key."/>
        <Property Name="Fingerprint" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="A fingerprint of the key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the fingerprint of the key."/>
          <Annotation Term="Validation.Pattern" String="(^MD5(:[0-9a-f]{2})+$)|(^SHA256:[A-Za-z0-9+/=]+$)"/>
        </Property>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_2_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="Key" BaseType="Key.v1_2_0.Key"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_3_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2023.2"/>

      <EntityType Name="Key" BaseType="Key.v1_2_0.Key"/>

      <ComplexType Name="SSHType" BaseType="Key.v1_2_0.SSHType">
        <Property Name="RemoteServerHostName" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The host name of the remote server associated with this key."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the host name of the remote server associated with this key."/>
        </Property>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_3_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="Key" BaseType="Key.v1_3_0.Key"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_4_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2023.3"/>

      <EntityType Name="Key" BaseType="Key.v1_3_0.Key"/>

      <ComplexType Name="SSHType" BaseType="Key.v1_3_0.SSHType">
        <Property Name="Comment" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The user-specified comment associated with this key, which typically contains the client's username and host name."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the user-specified comment associated with this key, which typically contains the client's username and host name."/>
        </Property>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Key.v1_4_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="Key" BaseType="Key.v1_4_0.Key"/>
    </Schema>

  </edmx:DataServices>
</edmx:Edmx>