/// <summary>
/// Allows a KeePass database to be opened directly from a cloud service
/// </summary>
public static async Task OpenDatabaseFromCloudService()
{
// Ask which cloud service to connect to
var cloudStorageProviderForm = new OneDriveCloudTypeForm {
ExplanationText = "Choose the cloud service you wish to open the KeePass database from:"
};
cloudStorageProviderForm.ShowDialog();
if (cloudStorageProviderForm.DialogResult != DialogResult.OK)
{
return;
}
// Create a new database configuration entry
var databaseConfig = new Configuration
{
CloudStorageType = cloudStorageProviderForm.ChosenCloudStorageType
};
// Verify the config object is ready to be used
if (!databaseConfig.CloudStorageType.HasValue)
{
UpdateStatus("Invalid cloud storage provider chosen");
return;
}
// Connect to OneDrive
var oneDriveApi = await Utilities.GetOneDriveApi(databaseConfig);
if (oneDriveApi == null)
{
switch (databaseConfig.CloudStorageType.Value)
{
case CloudStorageType.OneDriveConsumer: UpdateStatus("Failed to connect to OneDrive"); break;
case CloudStorageType.OneDriveForBusiness: UpdateStatus("Failed to connect to OneDrive for Business"); break;
default: UpdateStatus("Failed to connect to cloud service"); break;
}
return;
}
// Save the RefreshToken in the configuration so we can use it again next time
databaseConfig.RefreshToken = oneDriveApi.AccessToken.RefreshToken;
// Fetch details about this OneDrive account
var oneDriveAccount = await oneDriveApi.GetDrive();
databaseConfig.OneDriveName = oneDriveAccount.Owner.User.DisplayName;
// Ask the user to select the database to open on OneDrive
var oneDriveFilePickerDialog = new OneDriveFilePickerDialog(oneDriveApi)
{
ExplanationText = "Select the KeePass database to open. Right click for additional options.",
AllowEnteringNewFileName = false
};
await oneDriveFilePickerDialog.LoadFolderItems();
var result = oneDriveFilePickerDialog.ShowDialog();
if (result != DialogResult.OK || string.IsNullOrEmpty(oneDriveFilePickerDialog.FileName))
{
UpdateStatus("Open KeePass database from OneDrive aborted");
return;
}
databaseConfig.RemoteDatabasePath = (oneDriveFilePickerDialog.CurrentOneDriveItem.ParentReference != null ? oneDriveFilePickerDialog.CurrentOneDriveItem.ParentReference.Path : "") + "/" + oneDriveFilePickerDialog.CurrentOneDriveItem.Name + "/" + oneDriveFilePickerDialog.FileName;
databaseConfig.RemoteFolderId = oneDriveFilePickerDialog.CurrentOneDriveItem.Id;
databaseConfig.RemoteFileName = oneDriveFilePickerDialog.FileName;
// Retrieve the KeePass database from OneDrive
var oneDriveItem = await oneDriveApi.GetItemInFolder(databaseConfig.RemoteFolderId, databaseConfig.RemoteFileName);
if (oneDriveItem == null)
{
// KeePass database not found on OneDrive
switch (databaseConfig.CloudStorageType.Value)
{
case CloudStorageType.OneDriveConsumer: UpdateStatus("Unable to find the database on your OneDrive"); break;
case CloudStorageType.OneDriveForBusiness: UpdateStatus("Unable to find the database on your OneDrive for Business"); break;
default: UpdateStatus("Failed to connect to cloud service"); break;
}
return;
}
// Show the save as dialog to select a location locally where to store the KeePass database
var saveFiledialog = new SaveFileDialog
{
Filter = "KeePass databases (*.kdbx)|*.kdbx|All Files (*.*)|*.*",
Title = "Select where to store the KeePass database locally",
CheckFileExists = false,
FileName = oneDriveItem.Name
};
var saveFileDialogResult = saveFiledialog.ShowDialog();
if (saveFileDialogResult != DialogResult.OK || string.IsNullOrEmpty(saveFiledialog.FileName))
{
UpdateStatus("Open KeePass database from OneDrive aborted");
return;
}
// Download the KeePass database to the selected location
UpdateStatus("Downloading KeePass database");
await oneDriveApi.DownloadItemAndSaveAs(oneDriveItem, saveFiledialog.FileName);
// Register the KeePass database sync information
UpdateStatus("Configuring KeePass database");
databaseConfig.LocalFileHash = Utilities.GetDatabaseFileHash(saveFiledialog.FileName);
databaseConfig.ETag = oneDriveItem.ETag;
databaseConfig.LastSyncedAt = DateTime.Now;
databaseConfig.LastCheckedAt = DateTime.Now;
Configuration.PasswordDatabases.Add(saveFiledialog.FileName, databaseConfig);
Configuration.Save();
UpdateStatus("Opening KeePass database");
// Open the KeePass database
var databaseFile = IOConnectionInfo.FromPath(saveFiledialog.FileName);
KoenZomersKeePassOneDriveSyncExt.Host.MainWindow.OpenDatabase(databaseFile, null, false);
UpdateStatus("KeePass database is ready to be used");
}
/// <summary>
/// Checks if a newer database exists on OneDrive compared to the locally opened version and syncs them if so
/// </summary>
/// <param name="localKeePassDatabasePath">Full path or relative path from the KeePass executable folder to where the KeePass database resides locally</param>
/// <param name="updateStatus">Method to call to update the status</param>
/// <param name="forceSync">If True, no attempts will be made to validate if the local copy differs from the remote copy and it will always sync. If False, it will try to validate if there are any changes and not sync if there are no changes.</param>
public static async Task SyncDatabase(string localKeePassDatabasePath, Action <string> updateStatus, bool forceSync, Configuration databaseConfig)
{
// If something is already syncing, abort this attempt. This happens when the Import saves the resulting KeePass database. That by itself triggers another sync which doesn't have to go through the sync process as it just regards the temp database.
if (KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning)
{
return;
}
// Set flag to block exiting KeePass until this is done
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = true;
// Retrieve the KeePassOneDriveSync settings
if (databaseConfig == null)
{
databaseConfig = Configuration.GetPasswordDatabaseConfiguration(localKeePassDatabasePath);
}
// Check if this database explicitly does not allow to be synced with OneDrive and if syncing is enabled on this database
if (databaseConfig.DoNotSync || !databaseConfig.SyncingEnabled)
{
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Check if the current database is synced with OneDrive
if (string.IsNullOrEmpty(databaseConfig.RemoteDatabasePath) && string.IsNullOrEmpty(databaseConfig.RemoteFolderId) && string.IsNullOrEmpty(databaseConfig.RemoteFileName))
{
// Current database is not being syned with OneDrive, ask if it should be synced
var oneDriveAskToStartSyncingForm = new OneDriveAskToStartSyncingDialog(databaseConfig);
if (oneDriveAskToStartSyncingForm.ShowDialog() != DialogResult.OK)
{
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Ask which cloud service to connect to
var oneDriveCloudTypeForm = new OneDriveCloudTypeForm {
ExplanationText = "Choose the cloud service you wish to store the KeePass database on:"
};
if (oneDriveCloudTypeForm.ShowDialog() != DialogResult.OK)
{
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
databaseConfig.CloudStorageType = oneDriveCloudTypeForm.ChosenCloudStorageType;
Configuration.Save();
}
// Connect to OneDrive
OneDriveApi oneDriveApi = null;
bool retryGettingApiInstance;
do
{
retryGettingApiInstance = false;
try
{
oneDriveApi = await Utilities.GetOneDriveApi(databaseConfig);
}
catch (KoenZomers.OneDrive.Api.Exceptions.TokenRetrievalFailedException e)
{
// Failed to get a OneDrive API instance because retrieving an oAuth token failed. This could be because the oAuth token expired or has been removed. Show the login dialog again so we can get a new token.
databaseConfig.RefreshToken = null;
retryGettingApiInstance = true;
}
catch (Exception e)
{
// Build the error text to show to the end user
var errorMessage = new System.Text.StringBuilder();
errorMessage.Append("Failed to connect to ");
switch (databaseConfig.CloudStorageType.GetValueOrDefault(CloudStorageType.OneDriveConsumer))
{
case CloudStorageType.OneDriveConsumer:
errorMessage.Append("OneDrive");
break;
case CloudStorageType.OneDriveForBusiness:
errorMessage.Append("OneDrive for Business");
break;
default:
errorMessage.Append("cloud storage provider");
break;
}
errorMessage.AppendLine(":");
errorMessage.AppendLine();
errorMessage.AppendLine(e.Message);
// If there's an inner exception, show its message as well as it typically gives more detail why it went wrong
if (e.InnerException != null)
{
errorMessage.AppendLine(e.InnerException.Message);
// Verify if we're offline
if (e.InnerException.Message.Contains("remote name could not be resolved"))
{
// Offline, don't display a modal dialog but use the status bar instead
UpdateStatus("Can't connect. Working offline.");
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
}
MessageBox.Show(errorMessage.ToString(), "Connection failed", MessageBoxButtons.OK, MessageBoxIcon.Exclamation, MessageBoxDefaultButton.Button1);
}
} while (retryGettingApiInstance);
if (oneDriveApi == null)
{
switch (databaseConfig.CloudStorageType.GetValueOrDefault(CloudStorageType.OneDriveConsumer))
{
case CloudStorageType.OneDriveConsumer: updateStatus("Failed to connect to OneDrive"); break;
case CloudStorageType.OneDriveForBusiness: updateStatus("Failed to connect to OneDrive for Business"); break;
default: updateStatus("Failed to connect to cloud service"); break;
}
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Save the RefreshToken in the configuration so we can use it again next time
databaseConfig.RefreshToken = oneDriveApi.AccessToken.RefreshToken;
// Verify if we already have retrieved the name of this OneDrive
if (string.IsNullOrEmpty(databaseConfig.OneDriveName))
{
// Fetch details about this OneDrive account
var oneDriveAccount = await oneDriveApi.GetDrive();
databaseConfig.OneDriveName = oneDriveAccount.Owner.User.DisplayName;
}
Configuration.Save();
// Check if we have a location on OneDrive to sync with
if (string.IsNullOrEmpty(databaseConfig.RemoteDatabasePath) && string.IsNullOrEmpty(databaseConfig.RemoteFolderId) && string.IsNullOrEmpty(databaseConfig.RemoteFileName))
{
// Ask the user where to store the database on OneDrive
var oneDriveFilePickerDialog = new OneDriveFilePickerDialog(oneDriveApi)
{
ExplanationText = "Select where you want to store the KeePass database. Right click for additional options.",
AllowEnteringNewFileName = true
};
await oneDriveFilePickerDialog.LoadFolderItems();
var result = oneDriveFilePickerDialog.ShowDialog();
if (result != DialogResult.OK || string.IsNullOrEmpty(oneDriveFilePickerDialog.FileName))
{
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
databaseConfig.RemoteDatabasePath = (oneDriveFilePickerDialog.CurrentOneDriveItem.ParentReference != null ? oneDriveFilePickerDialog.CurrentOneDriveItem.ParentReference.Path : "") + "/" + oneDriveFilePickerDialog.CurrentOneDriveItem.Name + "/" + oneDriveFilePickerDialog.FileName;
databaseConfig.RemoteFolderId = oneDriveFilePickerDialog.CurrentOneDriveItem.Id;
databaseConfig.RemoteFileName = oneDriveFilePickerDialog.FileName;
Configuration.Save();
}
// Retrieve the KeePass database from OneDrive
var oneDriveItem = string.IsNullOrEmpty(databaseConfig.RemoteFolderId) ? await oneDriveApi.GetItem(databaseConfig.RemoteDatabasePath) : await oneDriveApi.GetItemInFolder(databaseConfig.RemoteFolderId, databaseConfig.RemoteFileName);
if (oneDriveItem == null)
{
// KeePass database not found on OneDrive
updateStatus("Database does not exist yet on OneDrive, uploading it now");
OneDriveItem oneDriveFolder;
string fileName;
if (string.IsNullOrEmpty(databaseConfig.RemoteFolderId))
{
oneDriveFolder = databaseConfig.RemoteDatabasePath.Contains("/") ? await oneDriveApi.GetFolderOrCreate(databaseConfig.RemoteDatabasePath.Remove(databaseConfig.RemoteDatabasePath.LastIndexOf("/", StringComparison.Ordinal))) : await oneDriveApi.GetDriveRoot();
fileName = databaseConfig.RemoteDatabasePath.Contains("/") ? databaseConfig.RemoteDatabasePath.Remove(0, databaseConfig.RemoteDatabasePath.LastIndexOf("/", StringComparison.Ordinal) + 1) : databaseConfig.RemoteDatabasePath;
}
else
{
oneDriveFolder = await oneDriveApi.GetItemById(databaseConfig.RemoteFolderId);
fileName = databaseConfig.RemoteFileName;
}
if (oneDriveFolder == null)
{
updateStatus("Unable to upload database to OneDrive. Remote path is invalid.");
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Upload the database to OneDrive
var newUploadResult = await oneDriveApi.UploadFileAs(localKeePassDatabasePath, fileName, oneDriveFolder);
updateStatus(newUploadResult == null ? "Failed to upload the KeePass database" : "Successfully uploaded the new KeePass database to OneDrive");
databaseConfig.LocalFileHash = Utilities.GetDatabaseFileHash(localKeePassDatabasePath);
if (newUploadResult != null)
{
databaseConfig.LastCheckedAt = DateTime.Now;
databaseConfig.LastSyncedAt = DateTime.Now;
databaseConfig.ETag = newUploadResult.ETag;
}
Configuration.Save();
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Use the ETag from the OneDrive item to compare it against the local database config etag to see if the content has changed
if (!forceSync && oneDriveItem.ETag == databaseConfig.ETag)
{
updateStatus("Databases are in sync");
databaseConfig.LastCheckedAt = DateTime.Now;
Configuration.Save();
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Download the database from OneDrive
updateStatus("Downloading KeePass database from OneDrive");
var temporaryKeePassDatabasePath = Path.GetTempFileName();
var downloadSuccessful = await oneDriveApi.DownloadItemAndSaveAs(oneDriveItem, temporaryKeePassDatabasePath);
if (!downloadSuccessful)
{
updateStatus("Failed to download the KeePass database from OneDrive");
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Sync database
updateStatus("KeePass database downloaded, going to sync");
// Ensure the database that needs to be synced is still the database currently selected in KeePass to avoid merging the downloaded database with the wrong database in KeePass
if ((!KoenZomersKeePassOneDriveSyncExt.Host.Database.IOConnectionInfo.Path.StartsWith(Environment.CurrentDirectory) && KoenZomersKeePassOneDriveSyncExt.Host.Database.IOConnectionInfo.Path != localKeePassDatabasePath) ||
(KoenZomersKeePassOneDriveSyncExt.Host.Database.IOConnectionInfo.Path.StartsWith(Environment.CurrentDirectory) && KoenZomersKeePassOneDriveSyncExt.Host.Database.IOConnectionInfo.Path.Remove(0, Environment.CurrentDirectory.Length + 1) != localKeePassDatabasePath))
{
updateStatus("Failed to sync. Please don't switch to another database before done.");
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
var connectionInfo = IOConnectionInfo.FromPath(temporaryKeePassDatabasePath);
var formatter = KoenZomersKeePassOneDriveSyncExt.Host.FileFormatPool.Find("KeePass KDBX (2.x)");
// Temporarily switch off syncing for this database to avoid the import operation, which causes a save, to create and endless loop
databaseConfig.SyncingEnabled = false;
// Import the current database with the downloaded database. Import causes a one way sync, syncing would try to update both ends which won't work for OneDrive.
var importSuccessful = ImportUtil.Import(KoenZomersKeePassOneDriveSyncExt.Host.Database, formatter, new[] { connectionInfo }, true, KoenZomersKeePassOneDriveSyncExt.Host.MainWindow, false, KoenZomersKeePassOneDriveSyncExt.Host.MainWindow);
// Enable syncing of this database again
databaseConfig.SyncingEnabled = true;
// Remove the temporary database from the Most Recently Used (MRU) list in KeePass as its added automatically on the import action
KoenZomersKeePassOneDriveSyncExt.Host.MainWindow.FileMruList.RemoveItem(temporaryKeePassDatabasePath);
if (!importSuccessful.GetValueOrDefault(false))
{
updateStatus("Failed to synchronize the KeePass databases");
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Upload the synced database
updateStatus("Uploading the new KeePass database to OneDrive");
var uploadResult = await oneDriveApi.UploadFileAs(temporaryKeePassDatabasePath, oneDriveItem.Name, oneDriveItem.ParentReference.Path.Equals("/drive/root:", StringComparison.CurrentCultureIgnoreCase)?await oneDriveApi.GetDriveRoot() : await oneDriveApi.GetItemById(oneDriveItem.ParentReference.Id));
if (uploadResult == null)
{
updateStatus("Failed to upload the KeePass database");
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
return;
}
// Delete the temporary database used for merging
File.Delete(temporaryKeePassDatabasePath);
// Update the KeePass UI so it shows the new entries
KoenZomersKeePassOneDriveSyncExt.Host.MainWindow.UpdateUI(false, null, true, null, true, null, false);
updateStatus("KeePass database has successfully been synchronized and uploaded");
databaseConfig.LocalFileHash = Utilities.GetDatabaseFileHash(localKeePassDatabasePath);
databaseConfig.ETag = uploadResult.ETag;
databaseConfig.LastSyncedAt = DateTime.Now;
databaseConfig.LastCheckedAt = DateTime.Now;
Configuration.Save();
// Set flag to allow exiting KeePass
KoenZomersKeePassOneDriveSyncExt.IsSomethingStillRunning = false;
}