steampipe plugin install ocisteampipe plugin install oci

Table: oci_kms_key - Query OCI Key Management Service Keys using SQL

Oracle Cloud Infrastructure's Key Management service enables you to manage the cryptographic keys used to protect your data. This service provides centralized key management, key lifecycle management, and cryptographic operations. It allows you to create, import, use, rotate, disable, and delete cryptographic keys.

Table Usage Guide

The oci_kms_key table provides insights into the keys within OCI Key Management Service. As a security engineer, explore key-specific details through this table, including key lifecycle states, creation time, and associated metadata. Utilize it to uncover information about keys, such as those nearing their expiration, the cryptographic algorithm used, and the verification of key usage.

Examples

Basic info

Explore the lifecycle state and creation time of your keys in Oracle Cloud Infrastructure's Key Management service. This can help you manage your keys effectively by identifying any keys that are outdated or in an undesirable state.

select
  id,
  name,
  lifecycle_state,
  time_created,
  vault_name
from
  oci_kms_key;

select
  id,
  name,
  lifecycle_state,
  time_created,
  vault_name
from
  oci_kms_key;

List keys that are not enabled

Discover the segments that consist of keys not currently enabled. This is useful to identify potential security risks or areas for system optimization.

select
  id,
  name,
  lifecycle_state,
  vault_name
from
  oci_kms_key
where
  lifecycle_state <> 'ENABLED';

select
  id,
  name,
  lifecycle_state,
  vault_name
from
  oci_kms_key
where
  lifecycle_state <> 'ENABLED';

List keys older than 365 days

Determine the areas in which encryption keys have been in use for over a year. This could be useful for identifying outdated security measures and ensuring a regular update cycle for enhanced data protection.

select
  id,
  name,
  lifecycle_state,
  vault_name
from
  oci_kms_key
where
  time_created <= (current_date - interval '365' day)
order by
  time_created;

select
  id,
  name,
  lifecycle_state,
  vault_name
from
  oci_kms_key
where
  time_created <= date('now', '-365 day')
order by
  time_created;

Query examples

Control examples

Schema for oci_kms_key

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form.
algorithm	text	=	The algorithm used by a key's key versions to encrypt or decrypt.
compartment_id	text		The OCID of the compartment in Tenant in which the resource is located.
current_key_version	text		The OCID of the key version used in cryptographic operations.
curve_id	text	=	Supported curve Ids for ECDSA keys.
defined_tags	jsonb		Defined tags for resource. Defined tags are set up in your tenancy by an administrator. Only users granted permission to work with the defined tags can apply them to resources.
freeform_tags	jsonb		Free-form tags for resource. This tags can be applied by any user with permissions on the resource.
id	text		The OCID of the key.
length	bigint	=	The length of the key.
lifecycle_state	text		The key's current lifecycle state.
management_endpoint	text		The service endpoint to perform management operations against.
name	text		A user-friendly name of the key. Does not have to be unique, and it's changeable.
protection_mode	text	=	The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
region	text		The OCI region in which the resource is located.
restored_from_key_id	text		The OCID of the key from which this key was restored.
sp_connection_name	text	=, !=, ~~, ~~, !~~, !~~	Steampipe connection name.
sp_ctx	jsonb		Steampipe context in JSON form.
tags	jsonb		A map of tags for the resource.
tenant_id	text	=, !=, ~~, ~~, !~~, !~~	The OCID of the Tenant in which the resource is located.
tenant_name	text		The name of the Tenant in which the resource is located.
time_created	timestamp with time zone		The date and time the key was created.
time_of_deletion	timestamp with time zone		An optional property indicating when to delete the key.
title	text		Title of the resource.
vault_id	text		The OCID of the vault that contains the key.
vault_name	text		The display name of the vault that contains the key.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- oci

You can pass the configuration to the command with the --config argument:

steampipe_export_oci --config '<your_config>' oci_kms_key