Skip to content

fix: reject creation of persistent secrets when allow_persistent_secrets=false for storage backends other than local_file #10199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mytherin merged 5 commits into from
Jan 12, 2024
Merged

fix: reject creation of persistent secrets when allow_persistent_secrets=false for storage backends other than local_file #10199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3c1e074
fix: reject creation of persistent secrets when allow_persistent_secr…
stephaniewang526 Jan 10, 2024
c5dd9df
update test case
stephaniewang526 Jan 10, 2024
f31e2db
update logic around persist_type resolution
stephaniewang526 Jan 11, 2024
9825cf1
Merge branch 'duckdb:main' into allow-persistent
stephaniewang526 Jan 11, 2024
be5f04e
format
stephaniewang526 Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/include/duckdb/main/secret/secret_storage.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ struct SecretEntry;

//! Base class for SecretStorage API
class SecretStorage {
friend class SecretManager;

public:
SecretStorage(const string &name) : storage_name(name), persistent(false) {};
virtual ~SecretStorage() = default;
Expand Down
37 changes: 19 additions & 18 deletions src/main/secret/secret_manager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,26 +158,29 @@ optional_ptr<SecretEntry> SecretManager::RegisterSecretInternal(CatalogTransacti
resolved_storage = storage;
}

if (resolved_storage != TEMPORARY_STORAGE_NAME && persist_type == SecretPersistType::TEMPORARY) {
throw InvalidInputException("Can not set secret storage for temporary secrets!");
}

//! Lookup which backend to store the secret in
auto backend = GetSecretStorage(resolved_storage);
if (backend) {
return backend->StoreSecret(transaction, std::move(secret), on_conflict);
if (!backend) {
throw InvalidInputException("Secret storage '%s' not found!", resolved_storage);
}

if (resolved_storage == LOCAL_FILE_STORAGE_NAME) {
if (!config.allow_persistent_secrets) {
throw InvalidInputException("Persistent secrets are currently disabled. To enable them, restart duckdb and "
"run 'SET allow_persistent_secrets=true'");
} else {
throw InternalException("The default local file storage for secrets was not found.");
// Validation on both allow_persistent_secrets and storage backend's own persist type
if (persist_type == SecretPersistType::PERSISTENT) {
if (backend->persistent) {
if (!config.allow_persistent_secrets) {
throw InvalidInputException(
"Persistent secrets are currently disabled. To enable them, restart duckdb and "
"run 'SET allow_persistent_secrets=true'");
}
} else { // backend is temp
throw InvalidInputException("Cannot create persistent secrets in a temporary secret storage!");
}
} else { // SecretPersistType::TEMPORARY
if (backend->persistent) {
throw InvalidInputException("Cannot create temporary secrets in a persistent secret storage!");
}
}

throw InvalidInputException("Secret storage '%s' not found!", resolved_storage);
return backend->StoreSecret(transaction, std::move(secret), on_conflict);
}

optional_ptr<CreateSecretFunction> SecretManager::LookupFunctionInternal(CatalogTransaction transaction,
Expand Down Expand Up @@ -493,10 +496,8 @@ void SecretManager::InitializeSecrets(CatalogTransaction transaction) {
LoadSecretStorageInternal(make_uniq<TemporarySecretStorage>(TEMPORARY_STORAGE_NAME, *transaction.db));

// load the persistent storage if enabled
if (config.allow_persistent_secrets) {
LoadSecretStorageInternal(
make_uniq<LocalFileSecretStorage>(*this, *transaction.db, LOCAL_FILE_STORAGE_NAME, config.secret_path));
}
LoadSecretStorageInternal(
make_uniq<LocalFileSecretStorage>(*this, *transaction.db, LOCAL_FILE_STORAGE_NAME, config.secret_path));

initialized = true;
}
Expand Down
6 changes: 3 additions & 3 deletions test/secrets/test_custom_secret_storage.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class TestSecretStorage : public CatalogSetSecretStorage {
TestSecretStorage(const string &name_p, DatabaseInstance &db, TestSecretLog &logger_p, int64_t tie_break_offset_p)
: CatalogSetSecretStorage(name_p), tie_break_offset(tie_break_offset_p), logger(logger_p) {
secrets = make_uniq<CatalogSet>(Catalog::GetSystemCatalog(db));
persistent = false;
persistent = true;
include_in_lookups = true;
}
bool IncludeInLookups() override {
Expand Down Expand Up @@ -65,7 +65,7 @@ TEST_CASE("Test adding a custom secret storage", "[secret][.]") {
auto &storage_ref = *storage_ptr;
secret_manager.LoadSecretStorage(std::move(storage_ptr));

REQUIRE_NO_FAIL(con.Query("set allow_persistent_secrets=false;"));
REQUIRE_NO_FAIL(con.Query("set allow_persistent_secrets=true;"));

REQUIRE_NO_FAIL(con.Query("CREATE SECRET s1 IN TEST_STORAGE (TYPE S3, SCOPE 's3://foo')"));
REQUIRE_NO_FAIL(con.Query("CREATE PERSISTENT SECRET s2 IN test_storage (TYPE S3, SCOPE 's3://')"));
Expand Down Expand Up @@ -128,7 +128,7 @@ TEST_CASE("Test tie-break behaviour for custom secret storage", "[secret][.]") {
TestSecretLog log1;
TestSecretLog log2;

REQUIRE_NO_FAIL(con.Query("set allow_persistent_secrets=false;"));
REQUIRE_NO_FAIL(con.Query("set allow_persistent_secrets=true;"));

// Register custom secret storage
auto &secret_manager = duckdb::SecretManager::Get(*db.instance);
Expand Down
2 changes: 1 addition & 1 deletion test/sql/secrets/create_secret_storage_backends.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ set allow_persistent_secrets=false;
statement error
CREATE TEMPORARY SECRET s1 IN LOCAL_FILE ( TYPE S3 )
----
Can not set secret storage for temporary secrets!
Cannot create temporary secrets in a persistent secret storage!

statement error
CREATE PERSISTENT SECRET s1 IN NON_EXISTENT_SECRET_STORAGE ( TYPE S3 )
Expand Down