bson/testdata/client-side-encryption/unified/getKeyByAltName.json

{
  "description": "getKeyByAltName",
  "schemaVersion": "1.8",
  "runOnRequirements": [
    {
      "csfle": true
    }
  ],
  "createEntities": [
    {
      "client": {
        "id": "client0",
        "observeEvents": [
          "commandStartedEvent"
        ]
      }
    },
    {
      "clientEncryption": {
        "id": "clientEncryption0",
        "clientEncryptionOpts": {
          "keyVaultClient": "client0",
          "keyVaultNamespace": "keyvault.datakeys",
          "kmsProviders": {
            "local": {
              "key": {
                "$$placeholder": 1
              }
            }
          }
        }
      }
    },
    {
      "database": {
        "id": "database0",
        "client": "client0",
        "databaseName": "keyvault"
      }
    },
    {
      "collection": {
        "id": "collection0",
        "database": "database0",
        "collectionName": "datakeys"
      }
    }
  ],
  "initialData": [
    {
      "databaseName": "keyvault",
      "collectionName": "datakeys",
      "documents": [
        {
          "_id": {
            "$binary": {
              "base64": "YXdzYXdzYXdzYXdzYXdzYQ==",
              "subType": "04"
            }
          },
          "keyAltNames": [
            "aws_key"
          ],
          "keyMaterial": {
            "$binary": {
              "base64": "AQICAHhQNmWG2CzOm1dq3kWLM+iDUZhEqnhJwH9wZVpuZ94A8gFXJqbF0Fy872MD7xl56D/2AAAAwjCBvwYJKoZIhvcNAQcGoIGxMIGuAgEAMIGoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDO7HPisPUlGzaio9vgIBEIB7/Qow46PMh/8JbEUbdXgTGhLfXPE+KIVW7T8s6YEMlGiRvMu7TV0QCIUJlSHPKZxzlJ2iwuz5yXeOag+EdY+eIQ0RKrsJ3b8UTisZYzGjfzZnxUKLzLoeXremtRCm3x47wCuHKd1dhh6FBbYt5TL2tDaj+vL2GBrKat2L",
              "subType": "00"
            }
          },
          "creationDate": {
            "$date": {
              "$numberLong": "1641024000000"
            }
          },
          "updateDate": {
            "$date": {
              "$numberLong": "1641024000000"
            }
          },
          "status": 1,
          "masterKey": {
            "provider": "aws",
            "key": "arn:aws:kms:us-east-1:579766882180:key/89fcc2c4-08b0-4bd9-9f25-e30687b580d0",
            "region": "us-east-1"
          }
        },
        {
          "_id": {
            "$binary": {
              "base64": "bG9jYWxrZXlsb2NhbGtleQ==",
              "subType": "04"
            }
          },
          "keyAltNames": [
            "local_key"
          ],
          "keyMaterial": {
            "$binary": {
              "base64": "ABKBldDEoDW323yejOnIRk6YQmlD9d3eQthd16scKL75nz2LjNL9fgPDZWrFFOlqlhMCFaSrNJfGrFUjYk5JFDO7soG5Syb50k1niJoKg4ilsj0L4mpimFUtTpOr2nzZOeQtvAksEXc7gsFgq8gV7t/U3lsaXPY7I0t42DfSE8EGlPdxRjFdHnxh+OR8h7U9b8Qs5K5UuhgyeyxaBZ1Hgw==",
              "subType": "00"
            }
          },
          "creationDate": {
            "$date": {
              "$numberLong": "1641024000000"
            }
          },
          "updateDate": {
            "$date": {
              "$numberLong": "1641024000000"
            }
          },
          "status": 1,
          "masterKey": {
            "provider": "local"
          }
        }
      ]
    }
  ],
  "tests": [
    {
      "description": "get non-existent data key",
      "operations": [
        {
          "name": "getKeyByAltName",
          "object": "clientEncryption0",
          "arguments": {
            "keyAltName": "does_not_exist"
          },
          "expectResult": {
            "$$unsetOrMatches": null
          }
        }
      ],
      "expectEvents": [
        {
          "client": "client0",
          "events": [
            {
              "commandStartedEvent": {
                "databaseName": "keyvault",
                "command": {
                  "find": "datakeys",
                  "filter": {
                    "keyAltNames": "does_not_exist"
                  },
                  "readConcern": {
                    "level": "majority"
                  }
                }
              }
            }
          ]
        }
      ]
    },
    {
      "description": "get existing AWS data key",
      "operations": [
        {
          "name": "getKeyByAltName",
          "object": "clientEncryption0",
          "arguments": {
            "keyAltName": "aws_key"
          },
          "expectResult": {
            "_id": {
              "$binary": {
                "base64": "YXdzYXdzYXdzYXdzYXdzYQ==",
                "subType": "04"
              }
            },
            "keyAltNames": [
              "aws_key"
            ],
            "keyMaterial": {
              "$binary": {
                "base64": "AQICAHhQNmWG2CzOm1dq3kWLM+iDUZhEqnhJwH9wZVpuZ94A8gFXJqbF0Fy872MD7xl56D/2AAAAwjCBvwYJKoZIhvcNAQcGoIGxMIGuAgEAMIGoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDO7HPisPUlGzaio9vgIBEIB7/Qow46PMh/8JbEUbdXgTGhLfXPE+KIVW7T8s6YEMlGiRvMu7TV0QCIUJlSHPKZxzlJ2iwuz5yXeOag+EdY+eIQ0RKrsJ3b8UTisZYzGjfzZnxUKLzLoeXremtRCm3x47wCuHKd1dhh6FBbYt5TL2tDaj+vL2GBrKat2L",
                "subType": "00"
              }
            },
            "creationDate": {
              "$date": {
                "$numberLong": "1641024000000"
              }
            },
            "updateDate": {
              "$date": {
                "$numberLong": "1641024000000"
              }
            },
            "status": 1,
            "masterKey": {
              "provider": "aws",
              "key": "arn:aws:kms:us-east-1:579766882180:key/89fcc2c4-08b0-4bd9-9f25-e30687b580d0",
              "region": "us-east-1"
            }
          }
        }
      ],
      "expectEvents": [
        {
          "client": "client0",
          "events": [
            {
              "commandStartedEvent": {
                "databaseName": "keyvault",
                "command": {
                  "find": "datakeys",
                  "filter": {
                    "keyAltNames": "aws_key"
                  },
                  "readConcern": {
                    "level": "majority"
                  }
                }
              }
            }
          ]
        }
      ]
    },
    {
      "description": "get existing local data key",
      "operations": [
        {
          "name": "getKeyByAltName",
          "object": "clientEncryption0",
          "arguments": {
            "keyAltName": "local_key"
          },
          "expectResult": {
            "_id": {
              "$binary": {
                "base64": "bG9jYWxrZXlsb2NhbGtleQ==",
                "subType": "04"
              }
            },
            "keyAltNames": [
              "local_key"
            ],
            "keyMaterial": {
              "$binary": {
                "base64": "ABKBldDEoDW323yejOnIRk6YQmlD9d3eQthd16scKL75nz2LjNL9fgPDZWrFFOlqlhMCFaSrNJfGrFUjYk5JFDO7soG5Syb50k1niJoKg4ilsj0L4mpimFUtTpOr2nzZOeQtvAksEXc7gsFgq8gV7t/U3lsaXPY7I0t42DfSE8EGlPdxRjFdHnxh+OR8h7U9b8Qs5K5UuhgyeyxaBZ1Hgw==",
                "subType": "00"
              }
            },
            "creationDate": {
              "$date": {
                "$numberLong": "1641024000000"
              }
            },
            "updateDate": {
              "$date": {
                "$numberLong": "1641024000000"
              }
            },
            "status": 1,
            "masterKey": {
              "provider": "local"
            }
          }
        }
      ],
      "expectEvents": [
        {
          "client": "client0",
          "events": [
            {
              "commandStartedEvent": {
                "databaseName": "keyvault",
                "command": {
                  "find": "datakeys",
                  "filter": {
                    "keyAltNames": "local_key"
                  },
                  "readConcern": {
                    "level": "majority"
                  }
                }
              }
            }
          ]
        }
      ]
    }
  ]
}