From daca37806e79bac494e0e6930235daab3e570207 Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Sun, 21 Jan 2024 19:11:24 -0500 Subject: [PATCH] Rename `sync.server.encryption_secret` to `sync.encryption_secret`. (#3249) * Rename `sync.server.encryption_secret` to `sync.encryption_secret`. * move pwgen --- doc/man/task-sync.5.in | 17 ++++++++++------- src/Context.cpp | 2 +- src/commands/CmdShow.cpp | 2 +- src/commands/CmdSync.cpp | 7 +++---- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/man/task-sync.5.in b/doc/man/task-sync.5.in index 041becb21..3483455b2 100644 --- a/doc/man/task-sync.5.in +++ b/doc/man/task-sync.5.in @@ -48,6 +48,16 @@ Taskwarrior provides several options for synchronizing your tasks: + To a cloud storage provider. Currently only GCP is supported. - To a local, on-disk file. +For most of these, you will need an encryption secret used to encrypt and +decrypt your tasks. This can be any secret string, and must match for all +replicas sharing tasks. + + $ task config sync.encryption_secret + +Tools such as +.BR pwgen (1) +can generate suitable secret values. + .SS Sync Server To synchronize your tasks to a sync server, you will need the following @@ -57,18 +67,11 @@ information from the server administrator: - The server's URL ("origin", such as "https://tw.example.com") .br - A client ID ("client_id") identifying your tasks -.br - - An encryption secret ("encryption_secret") used to encrypt and decrypt your tasks. This can be any secret string, and must match for all replicas using the same client ID. - -Tools such as -.BR pwgen (1) -can generate suitable secret values. Configure Taskwarrior with these details: $ task config sync.server.origin $ task config sync.server.client_id - $ task config sync.server.encryption_secret .SS Google Cloud Platform diff --git a/src/Context.cpp b/src/Context.cpp index aeb607f0f..0909ed12f 100644 --- a/src/Context.cpp +++ b/src/Context.cpp @@ -279,8 +279,8 @@ std::string configurationDefaults = "# WARNING: Please read the documentation (man task-sync) before setting up\n" "# Taskwarrior for Taskserver synchronization.\n" "\n" + "#sync.encryption_secret # Encryption secret for sync to a server\n" "#sync.server.client_id # Client ID for sync to a server\n" - "#sync.server.encryption_secret # Encryption secret for sync to a server\n" "#sync.server.origin # Origin of the sync server\n" "#sync.local.server_dir # Directory for local sync\n" "#sync.gcp.bucket # Bucket for sync to GCP\n" diff --git a/src/commands/CmdShow.cpp b/src/commands/CmdShow.cpp index 8c08901ff..75d819dd8 100644 --- a/src/commands/CmdShow.cpp +++ b/src/commands/CmdShow.cpp @@ -195,7 +195,7 @@ int CmdShow::execute (std::string& output) " sync.local.server_dir" " sync.gcp.bucket" " sync.server.client_id" - " sync.server.encryption_secret" + " sync.encryption_secret" " sync.server.origin" " tag.indicator" " undo.style" diff --git a/src/commands/CmdSync.cpp b/src/commands/CmdSync.cpp index 572416540..69e853d25 100644 --- a/src/commands/CmdSync.cpp +++ b/src/commands/CmdSync.cpp @@ -65,13 +65,13 @@ int CmdSync::execute (std::string& output) std::string origin = Context::getContext ().config.get ("sync.server.origin"); std::string server_dir = Context::getContext ().config.get ("sync.local.server_dir"); std::string gcp_bucket = Context::getContext ().config.get ("sync.gcp.bucket"); + std::string encryption_secret = Context::getContext ().config.get ("sync.encryption_secret"); if (server_dir != "") { server = tc::Server::new_local (server_dir); server_ident = server_dir; } else if (gcp_bucket != "") { - std::string encryption_secret = Context::getContext ().config.get ("sync.gcp.encryption_secret"); if (encryption_secret == "") { - throw std::string ("sync.gcp.encryption_secret is required"); + throw std::string ("sync.encryption_secret is required"); } server = tc::Server::new_gcp (gcp_bucket, encryption_secret); std::ostringstream os; @@ -79,9 +79,8 @@ int CmdSync::execute (std::string& output) server_ident = os.str(); } else if (origin != "") { std::string client_id = Context::getContext ().config.get ("sync.server.client_id"); - std::string encryption_secret = Context::getContext ().config.get ("sync.server.encryption_secret"); if (client_id == "" || encryption_secret == "") { - throw std::string ("sync.server.client_id and encryption_secret are required"); + throw std::string ("sync.server.client_id and sync.encryption_secret are required"); } server = tc::Server::new_sync (origin, client_id, encryption_secret); std::ostringstream os;