SERVER-53680 Use IDL for KeysCollectionDocument

1 files changed, 64 insertions, 0 deletions

diff --git a/src/mongo/db/keys_collection_document.idl b/src/mongo/db/keys_collection_document.idl
new file mode 100644
index 00000000000..dbffd8168a7
--- /dev/null
+++ b/src/mongo/db/keys_collection_document.idl
@@ -0,0 +1,64 @@
+# Copyright (C) 2021-present MongoDB, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the Server Side Public License, version 1,
+# as published by MongoDB, Inc.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# Server Side Public License for more details.
+#
+# You should have received a copy of the Server Side Public License
+# along with this program. If not, see
+# <http://www.mongodb.com/licensing/server-side-public-license>.
+#
+# As a special exception, the copyright holders give permission to link the
+# code of portions of this program with the OpenSSL library under certain
+# conditions as described in each individual source file and distribute
+# linked combinations including the program with the OpenSSL library. You
+# must comply with the Server Side Public License in all respects for
+# all of the code used other than as permitted herein. If you modify file(s)
+# with this exception, you may extend this exception to your version of the
+# file(s), but you are not obligated to do so. If you do not wish to do so,
+# delete this exception statement from your version. If you delete this
+# exception statement from all source files in the program, then also delete
+# it in the license file.
+#
+global:
+    cpp_namespace: "mongo"
+    cpp_includes:
+      - "mongo/db/logical_time.h"
+
+imports:
+  - "mongo/crypto/sha1_block.idl"
+  - "mongo/idl/basic_types.idl"
+
+types:
+  logicalTime:
+    description: "A MongoDB LogicalTime."
+    bson_serialization_type: any
+    cpp_type: LogicalTime
+    serializer: LogicalTime::serializeToBSON
+    deserializer: LogicalTime::parseFromBSON
+
+structs:
+    keysCollectionDocument:
+        description: >-
+            Represents a key document stored in admin.system.keys.
+        strict: true
+        fields:
+            _id:
+                type: safeInt64
+                description: >-
+                    NumberLong representation of the cluster time at which the key was created.
+                cpp_name: keyId
+            purpose:
+                type: string
+                description: "The purpose of the key."
+            key:
+                type: sha1Block
+                description: "20 byte key generated with secure PRNG in BinData."
+            expiresAt:
+                type: logicalTime
+                description: "The logical time at which the key will expire."