diff --git a/.circleci/config.yml b/.circleci/config.yml
index 5151a953..1890bf8f 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -6,26 +6,6 @@ version: 2.1
# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
jobs:
# Below is the definition of your job to build and test your app, you can rename and customize it as you want.
- build-and-test-8:
- # These next lines define a Docker executor: https://circleci.com/docs/2.0/executor-types/
- # You can specify an image from Dockerhub or use one of our Convenience Images from CircleCI's Developer Hub.
- # Be sure to update the Docker image tag below to openjdk version of your application.
- # A list of available CircleCI Docker Convenience Images are available here: https://circleci.com/developer/images/image/cimg/openjdk
- docker:
- - image: cimg/openjdk:8.0
- # Add steps to the job
- # See: https://circleci.com/docs/2.0/configuration-reference/#steps
- steps:
- # Checkout the code as the first step.
- - checkout
- # Use mvn clean and package as the standard maven build phase
- - run:
- name: Build
- command: mvn -B -DskipTests clean package
- # Then run your tests!
- - run:
- name: Test
- command: mvn -P inhibitConsoleOutput test
build-and-test-11:
# These next lines define a Docker executor: https://circleci.com/docs/2.0/executor-types/
@@ -51,8 +31,7 @@ jobs:
# Invoke jobs via workflows
# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
workflows:
- build-8-11: # This is the name of the workflow, feel free to change it to better match your workflow.
+ build-11: # This is the name of the workflow, feel free to change it to better match your workflow.
# Inside the workflow, you define the jobs you want to run.
jobs:
- - build-and-test-8
- build-and-test-11
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 00000000..721db89e
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,23 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*.java]
+charset = utf-8
+indent_style = space
+indent_size = 4
+# DO NOT USE insert_final_newline = true
+#insert_final_newline = true
+
+[*.yaml]
+indent_size = 2
+indent_style = space
+
+[*.sh]
+end_of_line = lf
+
+[*.cmd]
+end_of_line = crlf
+
+[*.py]
+indent_size = 4
+indent_style = space
\ No newline at end of file
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 00000000..1ddff4b5
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,39 @@
+* -text
+
+*.css text
+*.scss text
+*.sass text
+*.html text
+*.java text
+*.js text
+*.json text
+*.properties text
+*.txt text
+*.xml text
+*.py text
+*.cmd text
+*.bat text
+*.yaml text
+*.yml text
+*.sql text
+# *.ts text
+
+.gitignore text
+.gitattributes text
+.slugignore text
+.editorconfig text
+
+COPYING text
+README.md text
+mvnw text
+
+
+# These files are binary and should be left untouched
+*.class binary
+*.jar binary
+*.gif binary
+*.jpg binary
+*.png binary
+*.ico binary
+*.mp4 binary
+*.xcf binary
diff --git a/.gitignore b/.gitignore
index 3ee52c53..3da9b48e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@ build
.vscode/*
*.versionsBackup
**/target
+.idea
#settings.gradle
#gradlew
@@ -10,4 +11,5 @@ build
#.gradle
#gradle
#build.gradle
+Calc*_V3.class
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 3d066ab9..00000000
--- a/.travis.yml
+++ /dev/null
@@ -1,3 +0,0 @@
-language: java
-jdk: openjdk7
-script: mvn clean test
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c7a0aead..c6df680d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,7 +2,39 @@
Trying to follow the suggestions at [Keep a Change Log](http://keepachangelog.com) and [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
-## [2.2.3-SNAPSHOT]
+## [3.0.0-SNAPSHOT] (ongoing)
+
+### Changed
+
+- [Issue 81, 83] Remove junit dependency from main code and resolve test failure from UTF-8 encoding in test resources
+- [Issue 87] Problem with incorrect serialization of CustomIcons in Jackson implementation
+- [Issue 88] Incompatibility to KeePass due t missing empty element in autotype field in Jackson implementation
+- [Issue 90] Update dependencies to resolve security vulnerabilities
+- update to Java 11
+- refactor API
+ - remove complicated generics
+ - fluent element builder
+ - additional convenience methods
+- refactor examples
+- refactor modules
+ - rename Jackson database to KDBX database
+ - add experimental `basic` database support
+ - remove Simple database
+ - remove JAXB database
+ - remove DOM database
+ - remove `test` and `util` modules
+- refactor tests
+ - restructure
+ - create a test-jar for dependencies
+ - "upgrade" to JUnit 5
+
+
+## [2.2.4] 2025-03-05
+
+- [Issue 76, 78] Resolve incompatibility with KeePassXC (empty elements)
+- [Issue 73] Trying to resolve dependency clashes for Woodstox etc
+
+## [2.2.3] 2025-01-05
### Added
@@ -13,6 +45,12 @@ Trying to follow the suggestions at [Keep a Change Log](http://keepachangelog.co
- Jackson implementation supports this interface
- Other implementations throw exceptions appropriately as unsupported
+- [Issue #70] Improved support for KDBX 4.1 format (Jackson only)
+- [ISSUE #71] Module restructure to avoid test files, junit being pulled in unnecessarily
+
+### Fixed
+
+KDBX file format version 4.1 now supported (Issue-70) (in Jackson, not Simple)
## [2.2.2] 2024-09-06
diff --git a/DatabaseStructure.svg b/DatabaseStructure.svg
index 0694e7aa..6e7d6b57 100644
--- a/DatabaseStructure.svg
+++ b/DatabaseStructure.svg
@@ -1,4 +1,21 @@
+
+
\ No newline at end of file
diff --git a/KdbxDiagram.svg b/KdbxDiagram.svg
index fb278b1e..6aaefa8e 100644
--- a/KdbxDiagram.svg
+++ b/KdbxDiagram.svg
@@ -1,4 +1,21 @@
+
+
\ No newline at end of file
diff --git a/ModuleStructure.svg b/ModuleStructure.svg
index 9579dffe..d55374a0 100644
--- a/ModuleStructure.svg
+++ b/ModuleStructure.svg
@@ -1,4 +1,21 @@
+
+
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/PropertyValueProtection.md b/PropertyValueProtection.md
index ccb6f87d..f0e12a05 100644
--- a/PropertyValueProtection.md
+++ b/PropertyValueProtection.md
@@ -8,7 +8,7 @@ that have sensitive values are called "Protected Properties".
KDBX files contain a list of the standard properties and whether they are to be treated as protected
by default. The standard properties include Password, which is so treated. There doesn't seem to be a way of updating
this list in the Windows KeePass implementation, and in any case documentation says that the
-list is updated to default after load of a database, so it seems that it ignored.
+list is updated to default after load of a database, so it seems that it is ignored.
Individual properties can be marked as "protect in memory", but there is no way to indicate that
all properties of that name should be protected.
@@ -63,7 +63,7 @@ luck trying to avoid strings at all. Likewise, if you collect passwords from a d
After the deserialization process, the passwords are stored in RAM. Therefore:
**Hashing the password is not feasible**, as the hash function is a one-way process.
-This means that once a password is hashed, it cannot be reverted back to its original form,
+This means that once a password is hashed, it cannot be reverted to its original form,
which makes hashing unsuitable in this context. Since we need to retrieve and view
the saved passwords (as per the requirements), hashing does not meet the objective.
@@ -71,9 +71,10 @@ the saved passwords (as per the requirements), hashing does not meet the objecti
What key should be used for this process? If the key is stored in RAM, we are essentially creating
the same security vulnerability we are trying to avoid.
-While storing data in an encrypted form may seem appealing, keeping it encrypted in the KDBX InnerStream is impractical.
-This approach requires that the encrypted property values appear in the same order for both encryption and decryption, which makes it cumbersome.
-Encrypting and decrypting all protected fields each time we need to access or manipulate just one of them would add significant overhead.
+While storing data in an encrypted form may seem appealing, keeping it encrypted in the KDBX InnerStream
+is impractical. This approach requires that the encrypted property values appear in the same order for both
+encryption and decryption, which makes it cumbersome. Encrypting and decrypting all protected fields each
+time we need to access or manipulate just one of them would add significant overhead.
If the data is to be encrypted, then we need to find some way of storing the encryption key
that is not open to simple inspection.
diff --git a/KDBX.3.1.xsd b/XSD/KDBX.3.1.xsd
similarity index 99%
rename from KDBX.3.1.xsd
rename to XSD/KDBX.3.1.xsd
index ff22a5c7..be5c71f8 100644
--- a/KDBX.3.1.xsd
+++ b/XSD/KDBX.3.1.xsd
@@ -1,18 +1,19 @@
diff --git a/XSD/KDBX.4.1.reichl.xsd b/XSD/KDBX.4.1.reichl.xsd
new file mode 100644
index 00000000..6ccdda40
--- /dev/null
+++ b/XSD/KDBX.4.1.reichl.xsd
@@ -0,0 +1,509 @@
+
+
+
+
+
+ KDBX 4.1 XML Schema. Copyright (C) 2007-2025 Dominik Reichl. https://keepass.info/help/kb/kdbx.html
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name of the application that has generated the XML document.
+
+
+
+
+ Hash of the (unencrypted) header of a KDBX file. Used only in KDBX files prior to version 4. In KDBX ≥ 4, the integrity and the authenticity are ensured using a HMAC instead (see KDBX spec.).
+
+
+
+
+ Last date/time when a database setting (stored in the Meta element) has been changed.
+
+
+
+
+
+
+
+
+ User name that is used by default for new entries.
+
+
+
+
+
+ Number of days until history entries are deleted in a database maintenance operation.
+
+
+
+
+ Database color. The user interface can colorize elements with this color in order to allow the user to quickly identify the database.
+
+
+
+
+ Last date/time when the master key has been changed.
+
+
+
+
+ Number of days until a change of the master key is recommended. -1 means never.
+
+
+
+
+
+
+
+
+
+ Number of days until a change of the master key is enforced. -1 means never.
+
+
+
+
+
+
+
+
+
+ If true, a change of the master key should be enforced once directly after the user opens the database.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ UUID of the group that is used as recycle bin. Zero UUID = create new group when necessary.
+
+
+
+
+
+
+
+ Maximum number of history entries that each entry may have. -1 means unlimited.
+
+
+
+
+
+
+
+
+
+ Maximum estimated size in bytes (in the process memory) of the history of each entry. -1 means unlimited.
+
+
+
+
+
+
+
+
+
+
+
+ In this element, the content of each binary is stored. Used only in unencrypted XML files and in KDBX files prior to version 4. In KDBX ≥ 4, binaries are stored in the inner header (encrypted) instead.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Process memory protection settings, describing which standard fields should be protected. KeePass resets these settings to their default values after opening a database.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Reference to a binary content stored in the inner header (KDBX file) or in the Meta/Binaries element (unencrypted XML file).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in a KDBX file.
+
+
+
+
+ Used in an unencrypted XML file.
+
+
+
+
+
+
+
+
+
+
+ If the attribute is true, the content of the element has been encrypted (and Base64-encoded). See "inner encryption" on https://keepass.info/help/kb/kdbx.html
+
+
+
+
+
+ Custom data item (key/value pair) for plugins/ports. The key should be unique, e.g. "PluginName_ItemName".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ When the user deletes an object (group, entry, ...), an item is created in this list. When synchronizing/merging database files, this information can be used to decide whether an object has been deleted.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ In general, last access times are not reliable, because an access is not considered to be a database change. See the UIFlags value 0x20000: https://keepass.info/help/v2_dev/customize.html#uiflags
+
+
+
+
+
+
+ Cf. LastAccessTime.
+
+
+
+
+ Last date/time when the object has been moved (within its parent group or to a different group). This is used by the synchronization algorithm to determine the latest location of the object.
+
+
+
+
+
+
+
+
+
+
+
+
+ See the folder "Ext/Images_Client_HighRes" in the KeePass source code package.
+
+
+
+
+ Reference to a custom icon stored in the KeePassFile/Meta/CustomIcons element. If non-zero, it overrides IconID.
+
+
+
+
+
+ Specifies whether the group is displayed as expanded in the user interface.
+
+
+
+
+
+
+
+
+ UUID of the group in which the current group was stored previously. This information can for instance be used by a recycle bin restoration command.
+
+
+
+
+ Tags associated with the group, separated using ';'. https://keepass.info/help/v2/entry.html#tags
+
+
+
+
+
+
+
+
+
+
+
+
+
+ See TGroup/IconID.
+
+
+
+
+ See TGroup/CustomIconUUID.
+
+
+
+
+
+
+ https://keepass.info/help/base/autourl.html#override
+
+
+
+
+ https://keepass.info/help/v2/entry.html#gen https://keepass.info/help/kb/pw_quality_est.html
+
+
+
+
+ See TGroup/Tags.
+
+
+
+
+ See TGroup/PreviousParentGroup.
+
+
+
+
+
+
+
+
+
+ https://keepass.info/help/v2/entry.html#hst
+
+
+
+
+
+
+
+
+
+
+
+ https://keepass.info/help/base/autotype.html
+
+
+
+
+
+
+
+
+
+ No obfuscation.
+
+
+
+
+ Two-channel auto-type obfuscation. https://keepass.info/help/v2/autotype_obfuscation.html
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A hexadecimal CSS color of the form "#RRGGBB". For example, "#FFFF00" is yellow. An empty string means to use the default value (chosen by the application, suitable for the current UI).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ In a KDBX ≥ 4 file, dates are stored as the number of seconds (Int64) elapsed since 0001-01-01 00:00:00 UTC encoded using Base64. In an unencrypted XML file, dates are stored as xs:dateTime.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A 128-bit UUID encoded using Base64.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/XSD/KDBX.4.1.xsd b/XSD/KDBX.4.1.xsd
new file mode 100644
index 00000000..c6b3058a
--- /dev/null
+++ b/XSD/KDBX.4.1.xsd
@@ -0,0 +1,584 @@
+
+
+
+
+
+ The KDBX 4.1 XML format as used by KeePass 2.x compatible programs.
+
+ This is an update of earlier versions of the schema for versions 3.1 and 4 to be found at ../KDBX.{v}.xsd
+
+ The KDBX schema is documented (with somewhat different conventions) at
+ https://keepass.info/help/download/KDBX_XML.xsd. This schema was originally created as a) that XSD did
+ not exist at the time b) this schema was originally created to provide for JAXB bindings and was
+ tailored for that purpose.
+
+ In this version, artefacts that existed only to allow for JAXB purposes, for example abstract "parented"
+ elements to make it easier to add transient data in Java, have been removed. Also some correlation was
+ carried out with the XSD at keepass.info, which as mentioned did not originally exist at the time this
+ file was originally created. xs:sequence has been changed to xs:all where appropriate.
+
+ Conventions in this schema:
+
+ KeePassFile, Group, Entry, Times and History are top level elements as they may be useful for
+ creating fragments or something.
+
+ There are types for almost everything that contains documentation as to its purpose
+ and how it's used and if there are restrictions on the values.
+
+ Everything else is simply included inline for the sake of brevity. Undoubtedly
+ more documentation could most usefully be added.
+
+ Some elements are probably optional but are not marked as such. In real life they may be serialised
+ as empty elements and some are serialised with content "null". Actual serialisations will depend on
+ the view that various implementations have taken, so flexibility is required when loading. Historically
+ this was particularly true of boolean values.
+
+
+
+
+
+
+
+ The root element.
+
+
+
+
+
+
+ This contains database settings and also contains information
+ about the last state of the program that used the database. Presumably assuming
+ that the same program will be used to open it again, or that a different program
+ would want/need the same settings.
+
+
+
+
+
+ The name of an application. This might be an application
+ that created the original document or it could be an application that
+ altered it at some point.
+
+
+
+
+
+ Header hash removed from version 4. Hashes now contained
+ in the kdbx header itself.
+
+
+
+
+
+ The last time something in the enclosing meta element changed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ When the XML database is loaded into memory, sensitive
+ fields will be encrypted in that stream. This element specifies which of the
+ standardFields are encrypted in that stream, which is decrypted using Salsa20
+ for KDBX3 (or ChaCha20 by default for V4) and the InnerRandomStream encryption header.
+
+ ./Entry/String/Value/@Protected signifies that the value of a stringField is
+ so encrypted and applies also to customFields.
+
+ Attachments are optionally memory protected in V4.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used to store binary values in version 3.1 - in version 4
+ such values are now transferred as part of the KDBX inner headers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This is the root group which contains everything.
+
+
+
+
+
+ When the user permanently deletes an wrappedEntry or a group,
+ an item is created in this node. This allows the synchronization function
+ to decide whether an object has been deleted or is just missing in one of
+ the databases that are being synchronized.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ When it was last updated, resulting in an update to History if that is
+ active.
+
+
+
+
+
+ When it was originally created.
+
+
+
+
+ When was last used (read).
+
+
+
+
+ When it expires if it expires.
+
+
+
+
+ True if it expires.
+
+
+
+
+ How often the object has been used (e.g. by copying data of it to the
+ clipboard, performing auto-type with it, etc.). However, a change to the usage count is
+ not considered to be a database change (i.e. the database is not marked as changed by the
+ UI), thus this value is typically incorrect (and the same applies to the last access
+ time).
+
+
+
+
+
+ The date/time when the object was last moved. This allows the
+ synchronization function to correctly determine the most recent location of the
+ object.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ I think the preferred values are "True" and "False", but for the sake of accommodating
+ various non-conformant applications ... accept a wider variety.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This is ISO Date time stored as UTC (Z time zone).
+
+ In KDBX Version 4 this becomes a base64 encoded offset in seconds
+ from 0001-01-01T00:00:00Z - if stored in a KDBX encoded file, but
+ is a xs:dateTime otherwise. There is no attribute to say what the format is
+ so be prepared to do either.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ XSD doesn't do comma (or semicolon) separated lists, so we can't model this handily.
+
+ Assume that the format is something like [{token}{[,;] token}*]+ where white space is ignored except
+ as part of the name of the token.
+
+ See https://keepass.info/help/v2/entry.html#tags
+
+
+
+
+
+
+
+
+ This is where the values of the database are actually stored. You can have String valued
+ fields, and you can have Binary valued fields. There are "Default" String fields (username and so on) and
+ there are custom string fields (custom only in that their names are not the names of default string
+ fields). Not really clear whether the keys are case-sensitive.
+
+ Note that the "Protected" attribute is used in encrypted KDBX files and "ProtectInMemory" is used
+ in unencrypted XML files.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ If derived from a file then the Key element conventionally contains the file name.
+ I think it would be useful to add a mime type on this ...
+
+ The Value element is the value of /./meta/binaries/binary/@ID that is referenced from this
+ binary (V3 and XML formatted documents). Or in the inner header of a KDBX file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An index to one of the 69 built in icons.
+
+
+
+
+
+
+
+
+
+
+
+ Simply put: "#rrggbb".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the override URL, as documented at
+ http://keepass.info/help/base/autourl.html#override
+
+
+
+
+
+
+
+
+
+ Stores everything related to auto-type for this wrappedEntry.
+ http://keepass.info/help/base/autotype.html
+
+
+
+
+
+
+ 1 if Two-Channel Auto-Type Obfuscation is enabled, otherwise 0.
+ http://keepass.info/help/v2/autotype_obfuscation.html
+
+
+
+
+
+
+
+
+
+
+
+
+ Custom window/sequence association
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Number of days before triggering an event e.g. suggesting a password change.
+ -1 means never. 0 means every time.
+
+
+
+
+
+
+
+
+
+
+
+ A base64 encoded UUID. Each Group and Entry has a UUID. When added to History the same
+ UUID is maintained.
+
+
+
+
+
+
+
+ A reference to the UUID e.g. a Group like the Recycle bin. If, for
+ example, the recycle bin is enabled but has not been used, then it won't have been
+ created and the value stored here is a 0 UUID.
+
+
+
+
+
+
+
+ A reference to the custom icon UUID found in the meta/customIcons list.
+
+
+
+
+
+
+
+
+ Binary field for elements are centrally stored in this element.
+ The same Binary element may be referenced from many Entries.
+
+
+
+
+
+ The ID attribute is referenced in the Ref attribute of
+ a corresponding Binary element of an Entry. The Compressed attribute specifies
+ whether the base64 encoded value is to be decompressed to recover the binary
+ data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Third party programs and plugins can put custom data here.
+ Unique element names should be used, e.g. "PluginName_ItemName".
+
+
+
+
+
+
+ Note that "LastModificationTime" is actually only allowed when this appears in "Meta"
+ and not when it appears in "Entry" or "Group"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/KDBX.4.xsd b/XSD/KDBX.4.xsd
similarity index 99%
rename from KDBX.4.xsd
rename to XSD/KDBX.4.xsd
index 4fb7d70a..d0b7b130 100644
--- a/KDBX.4.xsd
+++ b/XSD/KDBX.4.xsd
@@ -1,18 +1,19 @@
- KeePassJava2-parent
- org.linguafranca.pwdb
- 2.2.3-SNAPSHOT
+ KeePassJava2.parent
+ mh.keepass
+ 1.0.0.1../pom.xml
@@ -27,32 +28,17 @@
KeePassJava2KeePassJava2 :: All
- KDB Database support as well as KDBX 3.1: DOM, JAXB and Simple implementations.
+ Composite containing KDBX and KDB Database support
- org.linguafranca.pwdb
- KeePassJava2-kdb
- ${project.version}
-
-
- org.linguafranca.pwdb
- KeePassJava2-dom
- ${project.version}
-
-
- org.linguafranca.pwdb
- KeePassJava2-jaxb
- ${project.version}
-
-
- org.linguafranca.pwdb
- KeePassJava2-simple
+ mh.keepass
+ KeePassJava2.kdb${project.version}
- org.linguafranca.pwdb
- KeePassJava2-jackson
+ mh.keepass
+ KeePassJava2.kdbx.database${project.version}
diff --git a/jaxb/src/main/java/org/linguafranca/pwdb/kdbx/jaxb/base/AbstractJaxbParentedBinding.java b/all/src/main/java/org/linguafranca/all/IgnoreMe.java
similarity index 56%
rename from jaxb/src/main/java/org/linguafranca/pwdb/kdbx/jaxb/base/AbstractJaxbParentedBinding.java
rename to all/src/main/java/org/linguafranca/all/IgnoreMe.java
index f9cb3ae1..d2d2bb71 100644
--- a/jaxb/src/main/java/org/linguafranca/pwdb/kdbx/jaxb/base/AbstractJaxbParentedBinding.java
+++ b/all/src/main/java/org/linguafranca/all/IgnoreMe.java
@@ -1,30 +1,24 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb.kdbx.jaxb.base;
-
-import javax.xml.bind.annotation.XmlTransient;
+package org.linguafranca.all;
/**
- * Ancestor class for Entry and Group Jaxb Bindings, allowing insertion of
- * a reference to the parent group.
- *
- * @author jo
+ * This is here for Javadoc generation purposes only
*/
-public abstract class AbstractJaxbParentedBinding {
- @XmlTransient
- public AbstractJaxbParentedBinding parent;
+public class IgnoreMe {
}
diff --git a/all/src/main/java/org/linguafranca/all/package-info.java b/all/src/main/java/org/linguafranca/all/package-info.java
new file mode 100644
index 00000000..83edcabd
--- /dev/null
+++ b/all/src/main/java/org/linguafranca/all/package-info.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+/**
+ * This package/module provides a simple import of the database implementations of KeePass, "all" in the diagram below.
+ *
+ *
+ *
+ * @see Module Structure
+ * in the readme at GitHub for a discussion of the project modules and links to JavaDocs.
+ */
+package org.linguafranca.all;
\ No newline at end of file
diff --git a/all/src/main/java/org/linguafranca/pwdb/IgnoreMe.java b/all/src/main/java/org/linguafranca/pwdb/IgnoreMe.java
deleted file mode 100644
index 0f2521c5..00000000
--- a/all/src/main/java/org/linguafranca/pwdb/IgnoreMe.java
+++ /dev/null
@@ -1,7 +0,0 @@
-package org.linguafranca.pwdb;
-
-/**
- * This is here for Javadoc generation purposes only
- */
-public class IgnoreMe {
-}
diff --git a/all/src/main/java/org/linguafranca/pwdb/package-info.java b/all/src/main/java/org/linguafranca/pwdb/package-info.java
deleted file mode 100644
index a544df96..00000000
--- a/all/src/main/java/org/linguafranca/pwdb/package-info.java
+++ /dev/null
@@ -1,9 +0,0 @@
-/**
- * This module provides a simple import of the database implementations of KeePass, "all" in the diagram below.
- *
- *
- *
- * @see Module Structure
- * in the readme at GitHub for a discussion of the project modules and links to JavaDocs.
- */
-package org.linguafranca.pwdb;
\ No newline at end of file
diff --git a/basic/pom.xml b/basic/pom.xml
new file mode 100644
index 00000000..87186e99
--- /dev/null
+++ b/basic/pom.xml
@@ -0,0 +1,72 @@
+
+
+
+
+ 4.0.0
+
+ mh.keepass
+ KeePassJava2.parent
+ 1.0.0.1
+
+
+ basic
+ PWDB :: Basic
+ Experimental database implementation to explore serialization.
+
+ true
+
+
+
+
+ mh.keepass
+ database
+ ${project.version}
+ compile
+
+
+ mh.keepass
+ KeePassJava2.kdbx.io
+ 1.0.0.1
+ compile
+
+
+ com.fasterxml.jackson.dataformat
+ jackson-dataformat-xml
+ 2.21.2
+
+
+ com.fasterxml.jackson.datatype
+ jackson-datatype-jsr310
+ 2.21.2
+
+
+ com.fasterxml.woodstox
+ woodstox-core
+ 7.1.0
+
+
+ mh.keepass
+ database
+ ${project.version}
+ test-jar
+ test
+
+
+
\ No newline at end of file
diff --git a/basic/src/main/java/org/linguafranca/pwdb/basic/BasicDatabase.java b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicDatabase.java
new file mode 100644
index 00000000..7abd4f4f
--- /dev/null
+++ b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicDatabase.java
@@ -0,0 +1,146 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.jspecify.annotations.Nullable;
+import org.linguafranca.pwdb.*;
+import org.linguafranca.pwdb.format.KdbxHeader;
+import org.linguafranca.pwdb.format.KdbxSerializer;
+import org.linguafranca.pwdb.format.KdbxStreamFormat;
+import org.linguafranca.pwdb.protect.ProtectedDatabase;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.time.Instant;
+import java.util.Objects;
+
+/**
+ * A basic implementation of a Database for experimentation and testing
+ */
+public class BasicDatabase extends ProtectedDatabase {
+ private final BasicGroup root = new BasicGroup(this, "Root");
+ private String databaseName = "New Database";
+ private String databaseDescription = "Database created on " + Instant.now().toString();
+ private StreamFormat streamFormat;
+
+ @Override
+ public Group getRootGroup() {
+ return root;
+ }
+
+ @Override
+ public Group newGroup() {
+ return new BasicGroup(this);
+ }
+
+ @Override
+ public Entry newEntry() {
+ return new BasicEntry(this);
+ }
+
+ @Override
+ public Icon newIcon() {
+ return new BasicIcon();
+ }
+
+ @Override
+ public Icon newIcon(Integer i) {
+ return new BasicIcon(i);
+ }
+
+ @Override
+ public boolean isRecycleBinEnabled() {
+ return false;
+ }
+
+ @Override
+ public void enableRecycleBin(boolean enable) {
+ throw new UnsupportedOperationException();
+ }
+
+ @Override
+ public @Nullable Group getRecycleBin() {
+ return null;
+ }
+
+ @Override
+ public String getName() {
+ return databaseName;
+ }
+
+ @Override
+ public void setName(String name) {
+ this.databaseName = name;
+ }
+
+ @Override
+ public String getDescription() {
+ return databaseDescription;
+ }
+
+ @Override
+ public void setDescription(String description) {
+ this.databaseDescription = description;
+ }
+
+ @Override
+ public void save(Credentials credentials, OutputStream outputStream) throws IOException {
+ if (Objects.isNull(streamFormat)) {
+ streamFormat = new KdbxStreamFormat(new KdbxHeader(4));
+ }
+ save(streamFormat, credentials, outputStream);
+ }
+
+ @Override
+ public void save(StreamFormat streamFormat,
+ Credentials credentials,
+ OutputStream outputStream) throws IOException {
+ KdbxStreamFormat kdbxStreamFormat = (KdbxStreamFormat) streamFormat;
+ KdbxHeader header = kdbxStreamFormat.getStreamConfiguration();
+ OutputStream encryptedOutputStream = KdbxSerializer.createEncryptedOutputStream(credentials, header, outputStream);
+ BasicDatabaseSerializer bds = new BasicDatabaseSerializer.Xml(header.getInnerStreamEncryptor());
+ bds.save(this, encryptedOutputStream);
+ }
+
+ @Override
+ public StreamFormat getStreamFormat() {
+ return streamFormat;
+ }
+
+
+ /**
+ * On load add parents
+ *
+ * @param parent a parent to recurse
+ */
+ void fixUp(BasicGroup parent) {
+ parent.database = this;
+ for (Group group : parent.getGroups()) {
+ BasicGroup basicGroup = (BasicGroup) group;
+ basicGroup.parent = parent;
+ fixUp(basicGroup);
+ }
+
+ for (Entry entry : parent.getEntries()) {
+ BasicEntry basicEntry = (BasicEntry) entry;
+ basicEntry.database = this;
+ basicEntry.parent = parent;
+ }
+ }
+
+}
diff --git a/basic/src/main/java/org/linguafranca/pwdb/basic/BasicDatabaseSerializer.java b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicDatabaseSerializer.java
new file mode 100644
index 00000000..c44425f1
--- /dev/null
+++ b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicDatabaseSerializer.java
@@ -0,0 +1,312 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import com.fasterxml.jackson.annotation.*;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import com.fasterxml.jackson.dataformat.xml.XmlMapper;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
+import com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import org.linguafranca.pwdb.PropertyValue;
+import org.linguafranca.pwdb.StreamFormat;
+import org.linguafranca.pwdb.protect.ProtectedDatabase;
+import org.linguafranca.pwdb.security.StreamEncryptor;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.List;
+
+/**
+ * This class is responsible for serializing and deserializing a BasicDatabase to and from a stream.
+ */
+public interface BasicDatabaseSerializer {
+
+ /**
+ * Serialize a BasicDatabase to a stream
+ *
+ * @param database the database to serialize
+ * @param outputStream the stream to serialize to
+ */
+ void save(BasicDatabase database, OutputStream outputStream) throws IOException;
+
+ /**
+ * Deserialize a BasicDatabase from a stream
+ *
+ * @param inputStream the serialized form of the database
+ * @return the deserialized database
+ */
+ BasicDatabase load(InputStream inputStream) throws IOException;
+
+ /**
+ * Serialize a BasicDatabase to a stream, with a runtime exception thrown if an IOException occurs
+ */
+ default void saveNx(BasicDatabase database, OutputStream outputStream){
+ try {
+ save(database, outputStream);
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ /**
+ * Deserialize a BasicDatabase from a stream, with a runtime exception thrown if an IOException occurs
+ */
+ default BasicDatabase loadNx(InputStream inputStream){
+ try {
+ return load(inputStream);
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+ /**
+ * XML implementation of containing BasicDatabaseSerializer
+ */
+ class Xml implements BasicDatabaseSerializer {
+ private final ObjectMapper objectMapper;
+ private final StreamEncryptor streamEncryptor;
+
+ public Xml() {
+ this(new StreamEncryptor.None());
+ }
+
+ public Xml(StreamEncryptor streamEncryptor) {
+ this.streamEncryptor = streamEncryptor;
+ this.objectMapper = init();
+ }
+
+ @Override
+ public void save(BasicDatabase database, OutputStream outputStream) throws IOException {
+ objectMapper.writer().withRootName("database").writeValue(outputStream, database);
+ }
+
+ @Override
+ public BasicDatabase load(InputStream inputStream) throws IOException {
+ BasicDatabase database2 = objectMapper.readValue(inputStream, BasicDatabase.class);
+ database2.fixUp((BasicGroup) database2.getRootGroup());
+ return database2;
+ }
+
+ private ObjectMapper init() {
+ SimpleModule module = new SimpleModule()
+ .addDeserializer(PropertyValue.class, new PropertyValueDeserializer(streamEncryptor))
+ .addSerializer(PropertyValue.class, new PropertyValueSerializer(streamEncryptor))
+ .addDeserializer(BasicIcon.class, new IconDeserializer())
+ .addSerializer(BasicIcon.class, new IconSerializer());
+ XmlMapper mapper = XmlMapper.builder()
+ // ignore everything except fields
+ .visibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY)
+ .visibility(PropertyAccessor.GETTER, JsonAutoDetect.Visibility.NONE)
+ .visibility(PropertyAccessor.IS_GETTER, JsonAutoDetect.Visibility.NONE)
+ .visibility(PropertyAccessor.SETTER, JsonAutoDetect.Visibility.NONE)
+ .visibility(PropertyAccessor.CREATOR, JsonAutoDetect.Visibility.NONE)
+ .disable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
+ // even though the source file is not annotated, we want annotations in the Configuration.class
+ .enable(MapperFeature.USE_ANNOTATIONS)
+ // add mixin to main classes
+ .addMixIn(BasicGroup.class, Configuration.class)
+ .addMixIn(BasicEntry.class, Configuration.class)
+ .addMixIn(BasicDatabase.class, Configuration.class)
+ .build();
+
+
+ mapper
+ // for PropertyValue serialization
+ .registerModule(module)
+ // for Instant processing
+ .registerModule(new JavaTimeModule())
+ // pretty print
+ .enable(SerializationFeature.INDENT_OUTPUT)
+ // suppress empty fields
+ .setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
+
+ return mapper;
+ }
+
+ /**
+ * Configure special treatment on serialization of properties
+ */
+ public static class PropertyValueSerializer extends JsonSerializer {
+ StreamEncryptor streamEncryptor;
+
+ public PropertyValueSerializer() {
+ this(new StreamEncryptor.None());
+ }
+
+ public PropertyValueSerializer(StreamEncryptor streamEncryptor) {
+ this.streamEncryptor = streamEncryptor;
+ }
+
+ /**
+ * Don't serialize empty properties
+ *
+ * TODO: at present, policy is to have all 5 standard properties present with empty
+ * value if necessary. Review policy. Deserialization messes up constructor
+ * behaviour which is to initialise those properties that way.
+ */
+ @Override
+ public boolean isEmpty(SerializerProvider provider, PropertyValue value) {
+ // TODO: return (value.getValueAsString().isEmpty());
+ return false;
+ }
+
+ /**
+ * write protected properties with a flag to show they need to be protected on input
+ */
+ @Override
+ public void serialize(PropertyValue value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
+
+ final ToXmlGenerator xmlGenerator = (ToXmlGenerator) gen;
+ // find out of we are serializing binaries
+ Object c = xmlGenerator.getOutputContext().getParent().getCurrentName();
+ boolean asBinary = c.equals("binaries");
+ xmlGenerator.writeStartObject();
+
+ if (value.isProtected()) {
+ xmlGenerator.setNextIsAttribute(true);
+ xmlGenerator.writeStringField("protected", "true");
+ asBinary = true; // write password as binary
+ }
+
+ if (asBinary) {
+ xmlGenerator.setNextIsAttribute(true);
+ xmlGenerator.writeStringField("binary", "true");
+ }
+ xmlGenerator.setNextIsAttribute(false);
+ xmlGenerator.setNextIsUnwrapped(true);
+
+ if (asBinary) {
+ byte[] bytes = value.getValueAsBytes();
+ if (value.isProtected()) {
+ bytes = streamEncryptor.encrypt(bytes);
+ }
+ xmlGenerator.writeBinaryField("text", bytes);
+ } else {
+ xmlGenerator.writeStringField("text", value.getValueAsString());
+ }
+ xmlGenerator.writeEndObject();
+ }
+ }
+
+ /**
+ * Property deserialization
+ */
+ public static class PropertyValueDeserializer extends JsonDeserializer {
+ PropertyValue.Strategy strategy;
+ StreamEncryptor streamEncryptor;
+
+ public PropertyValueDeserializer() {
+ this(new StreamEncryptor.None());
+ }
+
+ public PropertyValueDeserializer(StreamEncryptor streamEncryptor) {
+ this.streamEncryptor = streamEncryptor;
+ this.strategy = new PropertyValue.Strategy.Default();
+ }
+
+ @Override
+ public PropertyValue deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
+ JsonNode node = jsonParser.getCodec().readTree(jsonParser);
+
+ if (node.isTextual()) {
+ return strategy.newUnprotected().of(node.textValue());
+ }
+ if (node.has("binary")) {
+ if (node.has("protected")) {
+ byte[] bytes = streamEncryptor.decrypt(node.get("").binaryValue());
+ return strategy.newProtected().of(bytes);
+ }
+ return strategy.newUnprotected().of(node.get("").binaryValue());
+ }
+ throw new IllegalStateException("Unknown property value format " + node);
+ }
+ }
+
+ /**
+ * Configure special treatment for serialization of icons
+ */
+ public static class IconSerializer extends JsonSerializer {
+ /**
+ * flatten icon representation
+ */
+ @Override
+ public void serialize(BasicIcon icon, JsonGenerator gen, SerializerProvider serializers) throws IOException {
+
+ final ToXmlGenerator xmlGenerator = (ToXmlGenerator) gen;
+ xmlGenerator.writeStartObject();
+ xmlGenerator.setNextIsAttribute(true);
+ xmlGenerator.writeStringField("index", String.valueOf(icon.getIndex()));
+ xmlGenerator.writeEndObject();
+ }
+ }
+
+ /**
+ * Icon deserialization
+ */
+ public static class IconDeserializer extends JsonDeserializer {
+ PropertyValue.Strategy strategy = new PropertyValue.Strategy.Default();
+
+ @Override
+ public BasicIcon deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
+ JsonNode node = jsonParser.getCodec().readTree(jsonParser);
+
+ if (node.has("index")) {
+ return new BasicIcon(node.get("index").asInt());
+ }
+ throw new IllegalStateException("Unknown icon value format " + node);
+ }
+ }
+
+ /**
+ * Class is for binding Jackson annotations to a later Jackson "Mix-In"
+ */
+ public abstract static class Configuration {
+ // Tell Jackson how to treat lists of Entry and Groups
+ @JsonPropertyOrder({ "uuid", "icon", "properties", "binaries" })
+ protected static class BasicEntry {}
+
+ @JacksonXmlProperty(localName = "entry")
+ @JacksonXmlElementWrapper(useWrapping = false)
+ @JsonPropertyOrder({ "uuid", "icon", "properties", "binaries" })
+ protected List entries;
+
+ @JsonPropertyOrder({ "uuid", "name", "icon", "group", "entry" })
+ protected static class BasicGroup {}
+
+ @JacksonXmlProperty(localName = "group")
+ @JacksonXmlElementWrapper(useWrapping = false)
+ protected List groups;
+ // tell Jackson to ignore these fields
+ @JsonIgnore
+ BasicGroup parent;
+ @JsonIgnore
+ BasicDatabase database;
+ @JsonIgnore
+ ProtectedDatabase valueStrategy;
+ @JsonIgnore
+ boolean isDirty;
+ @JsonIgnore
+ StreamFormat streamFormat;
+ }
+ }
+}
diff --git a/basic/src/main/java/org/linguafranca/pwdb/basic/BasicEntry.java b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicEntry.java
new file mode 100644
index 00000000..adcbafdd
--- /dev/null
+++ b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicEntry.java
@@ -0,0 +1,236 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.jspecify.annotations.Nullable;
+import org.linguafranca.pwdb.*;
+import org.linguafranca.pwdb.abstractdb.AbstractEntry;
+
+import java.time.Instant;
+import java.util.*;
+
+public class BasicEntry extends AbstractEntry {
+ protected BasicDatabase database;
+ protected BasicGroup parent;
+
+ private final UUID uuid;
+ private BasicIcon icon;
+ private final Map properties = new HashMap<>();
+ private final Map binaries = new HashMap<>();
+
+ private final Instant creationTime;
+ private @Nullable Instant accessTime;
+ private @Nullable Instant modifiedTime;
+ private Instant expiryTime;
+ private boolean isExpires;
+
+
+ public BasicEntry() {
+ this.uuid = UUID.randomUUID();
+ this.creationTime = Instant.now();
+ this.icon = new BasicIcon(1);
+ for (String name : Entry.STANDARD_PROPERTY_NAMES) {
+ properties.put(name, new PropertyValue.StringStore(""));
+ }
+ }
+
+ public BasicEntry(BasicDatabase basicDatabase) {
+ this();
+ this.database = basicDatabase;
+ }
+
+ @Override
+ protected void touch() {
+ database.setDirty(true);
+ }
+
+ @Override
+ public @Nullable String getProperty(String name) {
+ if (!STANDARD_PROPERTY_NAMES.contains(name) && !database.supportsNonStandardPropertyNames()) {
+ throw new IllegalArgumentException("Property " + name + " is not a standard property name");
+ }
+ if (!properties.containsKey(name)) {
+ return null;
+ }
+ updateAccessTime();
+ return properties.get(name).getValueAsString();
+ }
+
+ @Override
+ public BasicEntry setProperty(String name, String value) {
+ updateModifiedTime();
+ properties.put(name, PropertyValue.StringStore.getFactory().of(value));
+ return this;
+ }
+
+ @Override
+ public boolean removeProperty(String name) throws IllegalArgumentException, UnsupportedOperationException {
+ if (Entry.STANDARD_PROPERTY_NAMES.contains(name)) {
+ throw new IllegalArgumentException("Cannot remove standard property");
+ }
+ if (!database.supportsNonStandardPropertyNames()) {
+ throw new UnsupportedOperationException("Database does not support non-standard properties");
+ }
+ boolean exists = properties.containsKey(name);
+ if (exists) {
+ updateModifiedTime();
+ }
+ properties.remove(name);
+ return exists;
+ }
+
+ @Override
+ public List getPropertyNames() {
+ return new ArrayList<>(properties.keySet());
+ }
+
+ @Override
+ public PropertyValue getPropertyValue(String name) {
+ return properties.get(name);
+ }
+
+ @Override
+ public BasicEntry setPropertyValue(String name, PropertyValue value) {
+ properties.put(name, value);
+ return this;
+ }
+
+ public BasicEntry addProperty(String name, byte[] value){
+ properties.put(name, database.getPropertyValueStrategy().getFactoryFor(name).of(value));
+ return this;
+ }
+ public BasicEntry addProperty(String name, char[] value) {
+ properties.put(name, database.getPropertyValueStrategy().getFactoryFor(name).of(value));
+ return this;
+ }
+
+ public BasicEntry addProperty(String name, CharSequence value){
+ properties.put(name, database.getPropertyValueStrategy().getFactoryFor(name).of(value));
+ return this;
+ }
+ @Override
+ public byte@Nullable [] getBinaryProperty(String name) {
+ if (!binaries.containsKey(name)) {
+ return null;
+ }
+ updateAccessTime();
+ return binaries.get(name).getValueAsBytes();
+ }
+
+ @Override
+ public void setBinaryProperty(String name, byte[] value) {
+ updateModifiedTime();
+ binaries.put(name, PropertyValue.BytesStore.getFactory().of(value));
+ }
+
+ @Override
+ public boolean removeBinaryProperty(String name) throws UnsupportedOperationException {
+ boolean exists = binaries.containsKey(name);
+ if (exists) {updateModifiedTime();}
+ binaries.remove(name);
+ return exists;
+ }
+
+ @Override
+ public List getBinaryPropertyNames() {
+ return List.of(binaries.keySet().toArray(String[]::new));
+ }
+
+ @Override
+ public BasicDatabase getDatabase() {
+ return database;
+ }
+
+ @Override
+ public @Nullable BasicGroup getParent() {
+ return parent;
+ }
+
+ @Override
+ public UUID getUuid() {
+ return uuid;
+ }
+
+ @Override
+ public BasicIcon getIcon() {
+ return icon;
+ }
+
+ @Override
+ public void setIcon(Icon icon) {
+ this.icon = (BasicIcon) icon;
+ }
+
+ @Override
+ public Date getLastAccessTime() {
+ if (accessTime == null) {
+ return fromInstant(this.creationTime);
+ }
+ return fromInstant(this.accessTime);
+ }
+
+ @Override
+ public Date getCreationTime() {
+ return fromInstant(creationTime);
+ }
+
+ @Override
+ public boolean getExpires() {
+ return this.isExpires;
+ }
+
+ @Override
+ public void setExpires(boolean expires) {
+ this.isExpires = expires;
+ }
+
+ @Override
+ public Date getExpiryTime() {
+ return fromInstant(this.expiryTime);
+ }
+
+ @Override
+ public void setExpiryTime(Date expiryTime) throws IllegalArgumentException {
+ this.expiryTime = expiryTime.toInstant();
+ }
+
+ @Override
+ public Date getLastModificationTime() {
+ if (modifiedTime == null) {
+ return fromInstant(this.creationTime);
+ }
+ return fromInstant(this.modifiedTime);
+ }
+
+ private void updateAccessTime() {
+ accessTime = Instant.now();
+ touch();
+ }
+
+ private void updateModifiedTime() {
+ modifiedTime = Instant.now();
+ touch();
+ }
+
+ private static @Nullable Date fromInstant(@Nullable Instant instant) {
+ if (instant == null) {
+ return null;
+ }
+ return Date.from(instant);
+ }
+}
diff --git a/basic/src/main/java/org/linguafranca/pwdb/basic/BasicGroup.java b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicGroup.java
new file mode 100644
index 00000000..adde7c00
--- /dev/null
+++ b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicGroup.java
@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.jspecify.annotations.Nullable;
+import org.linguafranca.pwdb.Database;
+import org.linguafranca.pwdb.Entry;
+import org.linguafranca.pwdb.Group;
+import org.linguafranca.pwdb.Icon;
+import org.linguafranca.pwdb.abstractdb.AbstractGroup;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.UUID;
+
+public class BasicGroup extends AbstractGroup {
+ protected BasicGroup parent;
+ protected BasicDatabase database;
+ private final UUID uuid;
+ private String name;
+ private BasicIcon icon;
+
+ private final List groups = new ArrayList<>();
+ private final List entries = new ArrayList<>();
+
+
+
+ BasicGroup () {
+ this.database = null;
+ this.uuid = UUID.randomUUID();
+ this.icon = new BasicIcon();
+ this.name = "";
+ }
+ BasicGroup(BasicDatabase database) {
+ this();
+ this.database = database;
+ }
+
+ BasicGroup(BasicDatabase database, String name) {
+ this(database);
+ this.name = name;
+ }
+
+ @Override
+ public boolean isRootGroup() {
+ return database.getRootGroup().equals(this);
+ }
+
+ @Override
+ public boolean isRecycleBin() {
+ return false;
+ }
+
+ @Override
+ public @Nullable BasicGroup getParent() {
+ return parent;
+ }
+
+ @Override
+ public void setParent(Group parent) {
+ this.parent = (BasicGroup) parent;
+ }
+
+ @Override
+ public List getGroups() {
+ return new ArrayList<>(groups);
+ }
+
+ @Override
+ public int getGroupsCount() {
+ return groups.size();
+ }
+
+ @Override
+ public Group addGroup(Group group) {
+ BasicGroup basicGroup = (BasicGroup) group;
+ groups.add(basicGroup);
+ basicGroup.parent = this;
+ return group;
+ }
+
+ @Override
+ public Group removeGroup(Group group) {
+ BasicGroup basicGroup = (BasicGroup) group;
+ groups.remove(basicGroup);
+ basicGroup.parent = null;
+ return group;
+ }
+
+ @Override
+ public List getEntries() {
+ return Collections.unmodifiableList(entries);
+ }
+
+ @Override
+ public int getEntriesCount() {
+ return entries.size();
+ }
+
+ @Override
+ public BasicEntry addEntry(Entry entry) {
+ BasicEntry basicEntry = (BasicEntry) entry;
+ entries.add(basicEntry);
+ basicEntry.parent = this;
+ return basicEntry;
+ }
+
+ @Override
+ public BasicEntry removeEntry(Entry entry) {
+ BasicEntry basicEntry = (BasicEntry) entry;
+ entries.remove(basicEntry);
+ (basicEntry).parent = null;
+ return basicEntry;
+ }
+
+ @Override
+ public String getName() {
+ return this.name;
+ }
+
+ @Override
+ public void setName(String name) {
+ this.name=name;
+ }
+
+ @Override
+ public UUID getUuid() {
+ return this.uuid;
+ }
+
+ @Override
+ public Icon getIcon() {
+ return this.icon;
+ }
+
+ @Override
+ public void setIcon(Icon icon) {
+ this.icon = (BasicIcon) icon;
+ }
+
+ @Override
+ public Database getDatabase() {
+ return this.database;
+ }
+}
diff --git a/jaxb/src/main/java/org/linguafranca/pwdb/kdbx/jaxb/JaxbIcon.java b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicIcon.java
similarity index 62%
rename from jaxb/src/main/java/org/linguafranca/pwdb/kdbx/jaxb/JaxbIcon.java
rename to basic/src/main/java/org/linguafranca/pwdb/basic/BasicIcon.java
index c558be3b..19006b47 100644
--- a/jaxb/src/main/java/org/linguafranca/pwdb/kdbx/jaxb/JaxbIcon.java
+++ b/basic/src/main/java/org/linguafranca/pwdb/basic/BasicIcon.java
@@ -1,36 +1,34 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb.kdbx.jaxb;
+package org.linguafranca.pwdb.basic;
import org.linguafranca.pwdb.Icon;
-/**
- * @author jo
- */
-@SuppressWarnings("WeakerAccess")
-public class JaxbIcon implements Icon{
+import java.util.Objects;
+
+public class BasicIcon implements Icon {
private int index;
- public JaxbIcon(int iconID) {
- index = iconID;
+ public BasicIcon() {
}
- public JaxbIcon() {
- index = 0;
+ public BasicIcon(Integer i) {
+ this.index = i;
}
@Override
@@ -45,17 +43,13 @@ public void setIndex(int index) {
@Override
public boolean equals(Object o) {
- if (this == o) return true;
- if (o == null || getClass() != o.getClass()) return false;
-
- JaxbIcon that = (JaxbIcon) o;
-
- return index == that.index;
-
+ if (!(o instanceof BasicIcon)) return false;
+ BasicIcon basicIcon = (BasicIcon) o;
+ return index == basicIcon.index;
}
@Override
public int hashCode() {
- return index;
+ return Objects.hashCode(index);
}
}
diff --git a/jaxb/src/test/java/org/linguafranca/pwdb/kdbx/jaxb/JaxbBasicDatabaseTest.java b/basic/src/main/java/org/linguafranca/pwdb/basic/package-info.java
similarity index 52%
rename from jaxb/src/test/java/org/linguafranca/pwdb/kdbx/jaxb/JaxbBasicDatabaseTest.java
rename to basic/src/main/java/org/linguafranca/pwdb/basic/package-info.java
index d4d08454..21f36f62 100644
--- a/jaxb/src/test/java/org/linguafranca/pwdb/kdbx/jaxb/JaxbBasicDatabaseTest.java
+++ b/basic/src/main/java/org/linguafranca/pwdb/basic/package-info.java
@@ -1,36 +1,28 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb.kdbx.jaxb;
-
-import org.linguafranca.pwdb.checks.BasicDatabaseChecks;
-import org.linguafranca.pwdb.Database;
-
-import java.io.IOException;
-
/**
- * @author jo
+ * This package contains the interfaces that define the org.linguafranca Database API.
+ *
+ * The API is designed to be a simple, low-level, read-write API for password databases.
+ *
+ * Class instances of the interfaces are contained in the sub-packages of this package.
*/
-public class JaxbBasicDatabaseTest extends BasicDatabaseChecks {
-
- public JaxbBasicDatabaseTest() throws IOException {
- }
+@NullMarked
+package org.linguafranca.pwdb.basic;
- @Override
- public Database createDatabase() {
- return new JaxbDatabase();
- }
-}
+import org.jspecify.annotations.NullMarked;
\ No newline at end of file
diff --git a/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseKdbxTest.java b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseKdbxTest.java
new file mode 100644
index 00000000..47409b70
--- /dev/null
+++ b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseKdbxTest.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.api.parallel.Execution;
+import org.linguafranca.pwdb.Database;
+import org.linguafranca.pwdb.KdbConsts;
+import org.linguafranca.pwdb.format.KdbxCredentials;
+import org.linguafranca.pwdb.format.KdbxHeader;
+import org.linguafranca.pwdb.format.KdbxSerializer;
+import org.linguafranca.pwdb.format.KdbxStreamFormat;
+import org.linguafranca.pwdb.test.DatabaseTestBase;
+
+import java.io.*;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
+import static org.linguafranca.pwdb.Entry.STANDARD_PROPERTY_NAME.*;
+
+@Execution(CONCURRENT)
+public class BasicDatabaseKdbxTest {
+
+ private static final Supplier dbFunc = ()-> new DatabaseTestBase(BasicDatabase::new,
+ (_, inputStream) ->
+ new BasicDatabaseSerializer.Xml().loadNx(inputStream),
+ (database, _, outputStream) ->
+ new BasicDatabaseSerializer.Xml().saveNx((BasicDatabase) database, outputStream),
+ (_) -> null);
+
+ @Test
+ public void testKdbx(@TempDir Path tempPath) throws IOException {
+ DatabaseTestBase databaseTestBase = BasicDatabaseKdbxTest.dbFunc.get();
+ Database db = databaseTestBase.database;
+ db.setName("test");
+ db.getRootGroup().addEntry("test")
+ .addProperty(PASSWORD,"password")
+ .addProperty(URL,"http://example.com")
+ .addProperty(USER_NAME,"user");
+
+ Path dbPath = tempPath.resolve("test.kdbx");
+ db.save(new KdbxStreamFormat(), new KdbxCredentials(KdbConsts.PASSWORD_BYTES), Files.newOutputStream(dbPath));
+
+ KdbxHeader header = new KdbxHeader();
+ InputStream unencryptedInputStream = KdbxSerializer.createUnencryptedInputStream(new KdbxCredentials(KdbConsts.PASSWORD_BYTES),
+ header, Files.newInputStream(dbPath));
+
+ BasicDatabaseSerializer.Xml xml = new BasicDatabaseSerializer.Xml(header.getInnerStreamEncryptor());
+ Database db2 = xml.load(unencryptedInputStream);
+ assertEquals(db.getName(), db2.getName());
+ assertEquals(db2.getRootGroup().findEntries(e -> true, true).size(), db.getRootGroup().findEntries(e -> true, true).size());
+ assertEquals("password", db2.getRootGroup().findEntries(e -> e.getTitle().equals("test"), true).get(0).getPropertyValue(PASSWORD).getValueAsString());
+ }
+}
diff --git a/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseSerializerTest.java b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseSerializerTest.java
new file mode 100644
index 00000000..5cfe5ca1
--- /dev/null
+++ b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseSerializerTest.java
@@ -0,0 +1,115 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ * Copyright (c) 2026. Sergio Lissner
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.api.parallel.Execution;
+import org.linguafranca.pwdb.Entry;
+import org.linguafranca.pwdb.Group;
+import org.linguafranca.pwdb.Visitor;
+import org.linguafranca.pwdb.security.StreamEncryptor;
+
+import java.io.*;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Arrays;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
+import static org.linguafranca.util.TestUtil.getTestPrintStream;
+
+@Execution(CONCURRENT)
+class BasicDatabaseSerializerTest {
+
+ static BasicDatabase setUpBasicDatabase() {
+
+ BasicDatabase database;
+ database = new BasicDatabase();
+ database.setName("My Database");
+ database.setDescription("A database of passwords");
+ database.getRootGroup().addGroup("Group 1")
+ .addEntry("Entry 1")
+ .addProperty(Entry.STANDARD_PROPERTY_NAME.USER_NAME, "John Doe")
+ .addProperty(Entry.STANDARD_PROPERTY_NAME.PASSWORD, "password123".getBytes())
+ .addEntry("Entry 2")
+ .addProperty(Entry.STANDARD_PROPERTY_NAME.USER_NAME, "Jane Doe")
+ .addProperty(Entry.STANDARD_PROPERTY_NAME.PASSWORD, "password123".getBytes())
+ .addProperty("non-standard", "non-standard value")
+ .addEntry("Entry 3")
+ .setBinaryProperty("gif", new byte[]{1, 2, 3, 4, 5});
+ return database;
+ }
+
+ public static Visitor setUpVisitor(BasicDatabase database, PrintStream out) {
+ Visitor visitor = new Visitor() {
+ @Override
+ public void startVisit(Group group) {
+ out.println("Group: " + group.getName() + " " + group.getUuid());
+ assertNotNull(database.findGroup(group.getUuid()));
+ assertNotNull(group.getDatabase());
+ if (!group.isRootGroup()) {
+ assertNotNull(group.getParent());
+ }
+ }
+
+ @Override
+ public void endVisit(Group group) {
+
+ }
+
+ @Override
+ public void visit(Entry entry) {
+ out.println("Entry: " + entry.getTitle() + " " + entry.getUuid());
+ for (String propertyName: entry.getPropertyNames()) {
+ out.println(" " + propertyName + ": " + entry.getPropertyValue(propertyName).getValueAsString());
+ }
+ for (String propertyName: entry.getBinaryPropertyNames()) {
+ out.println(" " + propertyName + ": " + Arrays.toString(entry.getBinaryProperty(propertyName)));
+ }
+ Entry entry1 = database.findEntry(entry.getUuid());
+ assertNotNull(entry1, "Entry not found " + entry.getUuid());
+ assertEquals(entry.getPropertyNames().size(), entry1.getPropertyNames().size());
+ assertNotNull(entry.getDatabase());
+ assertNotNull(entry.getParent());
+ }
+
+ @Override
+ public boolean isEntriesFirst() {
+ return false;
+ }
+ };
+ return visitor;
+ }
+
+ @Test
+ void saveAndLoad(@TempDir Path tempPath) throws IOException {
+ PrintStream out = getTestPrintStream();
+
+ BasicDatabase basicDatabase = setUpBasicDatabase();
+ OutputStream outputStream = Files.newOutputStream(tempPath.resolve("test.xml"));
+ new BasicDatabaseSerializer.Xml(new StreamEncryptor.Salsa20(new byte[0])).save(basicDatabase, outputStream);
+
+ InputStream inputStream = Files.newInputStream(tempPath.resolve( "test.xml"));
+ BasicDatabase loadedDatabase = new BasicDatabaseSerializer.Xml(new StreamEncryptor.Salsa20(new byte[0])).load(inputStream);
+ loadedDatabase.visit(setUpVisitor(basicDatabase, out));
+ out.println(loadedDatabase.getRootGroup().getDatabase().getName());
+ }
+}
\ No newline at end of file
diff --git a/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseTest.java b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseTest.java
new file mode 100644
index 00000000..61c3ca01
--- /dev/null
+++ b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicDatabaseTest.java
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.junit.jupiter.api.parallel.Execution;
+import org.linguafranca.pwdb.test.*;
+
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
+
+@Execution(CONCURRENT)
+public class BasicDatabaseTest
+ implements
+ TrivialDatabaseTest,
+ GroupsAndEntriesTest,
+ RecycleBinTest,
+ ProtectedPropertyTest,
+ ProtectedPropertyTest2 {
+
+ private static final Supplier dbFunc = ()-> new DatabaseTestBase(BasicDatabase::new,
+ (_, inputStream) ->
+ new BasicDatabaseSerializer.Xml().loadNx(inputStream),
+ (database, _, outputStream) ->
+ new BasicDatabaseSerializer.Xml().saveNx((BasicDatabase) database, outputStream),
+ (_) -> null);
+
+ @Override
+ public Supplier getDbFunc() {
+ return dbFunc;
+ }
+}
diff --git a/basic/src/test/java/org/linguafranca/pwdb/basic/BasicEntryTest.java b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicEntryTest.java
new file mode 100644
index 00000000..d0b923cb
--- /dev/null
+++ b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicEntryTest.java
@@ -0,0 +1,184 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
+
+import java.time.Instant;
+import java.util.Date;
+import java.util.List;
+import java.util.UUID;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
+
+@Execution(CONCURRENT)
+class BasicEntryTest {
+
+ @Test
+ void testGetProperty() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ entry.setProperty("name", "value");
+ assertEquals("value", entry.getProperty("name"));
+ }
+
+ @Test
+ void testSetProperty() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ entry.setProperty("name", "value");
+ assertEquals("value", entry.getProperty("name"));
+ }
+
+ @Test
+ void testRemoveProperty() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ entry.setProperty("name", "value");
+ assertTrue(entry.removeProperty("name"));
+ assertNull(entry.getProperty("name"));
+ }
+
+ @Test
+ void testGetPropertyNames() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ entry.setProperty("name1", "value1");
+ entry.setProperty("name2", "value2");
+ List propertyNames = entry.getPropertyNames();
+ assertTrue(propertyNames.contains("name1"));
+ assertTrue(propertyNames.contains("name2"));
+ }
+
+ @Test
+ void testGetBinaryProperty() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ byte[] data = {1, 2, 3};
+ entry.setBinaryProperty("binary", data);
+ assertArrayEquals(data, entry.getBinaryProperty("binary"));
+ }
+
+ @Test
+ void testSetBinaryProperty() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ byte[] data = {1, 2, 3};
+ entry.setBinaryProperty("binary", data);
+ assertArrayEquals(data, entry.getBinaryProperty("binary"));
+ }
+
+ @Test
+ void testRemoveBinaryProperty() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ byte[] data = {1, 2, 3};
+ entry.setBinaryProperty("binary", data);
+ assertTrue(entry.removeBinaryProperty("binary"));
+ assertNull(entry.getBinaryProperty("binary"));
+ }
+
+ @Test
+ void testGetBinaryPropertyNames() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+
+ byte[] data1 = {1, 2, 3};
+ byte[] data2 = {4, 5, 6};
+ entry.setBinaryProperty("binary1", data1);
+ entry.setBinaryProperty("binary2", data2);
+ List binaryPropertyNames = entry.getBinaryPropertyNames();
+ assertTrue(binaryPropertyNames.contains("binary1"));
+ assertTrue(binaryPropertyNames.contains("binary2"));
+ }
+
+ @Test
+ void testGetParent() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ assertNull(entry.getParent());
+ }
+
+ @Test
+ void testGetUuid() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ UUID uuid = entry.getUuid();
+ assertNotNull(uuid);
+ }
+
+ @Test
+ void testGetIcon() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ assertNotNull(entry.getIcon());
+ }
+
+ @Test
+ void testSetIcon() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ entry.setIcon(new BasicIcon(1) {});
+ assertEquals(1, entry.getIcon().getIndex());
+ }
+
+ @Test
+ void testGetLastAccessTime() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ Date lastAccessTime = entry.getLastAccessTime();
+ assertNotNull(lastAccessTime);
+ }
+
+ @Test
+ void testGetCreationTime() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ Date creationTime = entry.getCreationTime();
+ assertNotNull(creationTime);
+ }
+
+ @Test
+ void testGetExpires() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ assertFalse(entry.getExpires());
+ }
+
+ @Test
+ void testSetExpires() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ entry.setExpires(true);
+ assertTrue(entry.getExpires());
+ }
+
+ @Test
+ void testGetExpiryTime() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ assertNull(entry.getExpiryTime());
+ }
+
+ @Test
+ void testSetExpiryTime() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ Date expiryTime = Date.from(Instant.now());
+ entry.setExpiryTime(expiryTime);
+ assertEquals(expiryTime, entry.getExpiryTime());
+ }
+
+ @Test
+ void testGetLastModificationTime() {
+ BasicEntry entry= new BasicEntry(new BasicDatabase());
+ assertEquals(entry.getCreationTime(), entry.getLastModificationTime());
+ }
+}
diff --git a/basic/src/test/java/org/linguafranca/pwdb/basic/BasicGroupTest.java b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicGroupTest.java
new file mode 100644
index 00000000..9882b169
--- /dev/null
+++ b/basic/src/test/java/org/linguafranca/pwdb/basic/BasicGroupTest.java
@@ -0,0 +1,130 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.basic;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
+import org.linguafranca.pwdb.Entry;
+import org.linguafranca.pwdb.Group;
+
+import java.util.List;
+import java.util.UUID;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
+
+@Execution(CONCURRENT)
+class BasicGroupTest {
+
+ @Test
+ void testGetName() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ group.setName("Test Group");
+ assertEquals("Test Group", group.getName());
+ }
+
+ @Test
+ void testSetName() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ group.setName("Test Group");
+ assertEquals("Test Group", group.getName());
+ }
+
+ @Test
+ void testGetEntries() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ Entry entry = new BasicEntry(new BasicDatabase());
+ group.addEntry(entry);
+ List entries = group.getEntries();
+ assertTrue(entries.contains(entry));
+ }
+
+ @Test
+ void testAddEntry() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ Entry entry = new BasicEntry(new BasicDatabase());
+ group.addEntry(entry);
+ assertTrue(group.getEntries().contains(entry));
+ }
+
+ @Test
+ void testRemoveEntry() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ Entry entry = new BasicEntry(new BasicDatabase());
+ group.addEntry(entry);
+ group.removeEntry(entry);
+ assertFalse(group.getEntries().contains(entry));
+ }
+
+ @Test
+ void testGetGroups() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ Group subGroup = new BasicGroup(new BasicDatabase());
+ group.addGroup(subGroup);
+ List groups = group.getGroups();
+ assertTrue(groups.contains(subGroup));
+ }
+
+ @Test
+ void testAddGroup() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ Group subGroup = new BasicGroup(new BasicDatabase());
+ group.addGroup(subGroup);
+ assertTrue(group.getGroups().contains(subGroup));
+ }
+
+ @Test
+ void testRemoveGroup() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ Group subGroup = new BasicGroup(new BasicDatabase());
+ group.addGroup(subGroup);
+ assertTrue(group.getGroups().contains(subGroup));
+ assertEquals(1, group.getGroups().size());
+ assertEquals(group, subGroup.getParent());
+ group.removeGroup(subGroup);
+ assertEquals(0, group.getGroups().size());
+ assertNull(subGroup.getParent());
+ assertFalse(group.getGroups().contains(subGroup));
+ }
+
+ @Test
+ void testGetParent() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ assertNull(group.getParent());
+ }
+
+ @Test
+ void testGetUuid() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ UUID uuid = group.getUuid();
+ assertNotNull(uuid);
+ }
+
+ @Test
+ void testGetIcon() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ assertEquals(0, group.getIcon().getIndex());
+ }
+
+ @Test
+ void testSetIcon() {
+ BasicGroup group = new BasicGroup(new BasicDatabase());
+ group.setIcon(new BasicIcon(1));
+ assertEquals(1, group.getIcon().getIndex());
+ }
+}
\ No newline at end of file
diff --git a/basic/src/test/java/org/linguafranca/pwdb/basic/package-info.java b/basic/src/test/java/org/linguafranca/pwdb/basic/package-info.java
new file mode 100644
index 00000000..5ecf339c
--- /dev/null
+++ b/basic/src/test/java/org/linguafranca/pwdb/basic/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ * Copyright (c) 2026. Sergio Lissner
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+@NullMarked
+package org.linguafranca.pwdb.basic;
+
+import org.jspecify.annotations.NullMarked;
\ No newline at end of file
diff --git a/basic/src/test/resources/junit-platform.properties b/basic/src/test/resources/junit-platform.properties
new file mode 100644
index 00000000..2115a2f1
--- /dev/null
+++ b/basic/src/test/resources/junit-platform.properties
@@ -0,0 +1 @@
+junit.jupiter.execution.parallel.enabled = true
diff --git a/bitbucket-pipelines.yml b/bitbucket-pipelines.yml
deleted file mode 100644
index a8c1de44..00000000
--- a/bitbucket-pipelines.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-# This is a sample build configuration for Java (Maven).
-# Check our guides at https://confluence.atlassian.com/x/zd-5Mw for more examples.
-# Only use spaces to indent your .yml configuration.
-# -----
-# You can specify a custom docker image from Docker Hub as your build environment.
-image: maven:3.5.2-jdk-7
-
-pipelines:
- #only on this branch
- bitbucket-build:
- - step:
- caches:
- - maven
- script: # Modify the commands below to build your repository.
- - mvn -B verify # -B batch mode makes Maven less verbose
\ No newline at end of file
diff --git a/database/pom.xml b/database/pom.xml
index f4095dec..5fb14aab 100644
--- a/database/pom.xml
+++ b/database/pom.xml
@@ -1,31 +1,71 @@
-
-
- KeePassJava2-parent
- org.linguafranca.pwdb
- 2.2.3-SNAPSHOT
- ../pom.xml
-
- 4.0.0
+
- database
- PWDB :: Database
- Contains root definitions of PWDB Databases etc.
+
+
+ KeePassJava2.parent
+ mh.keepass
+ 1.0.0.1
+ ../pom.xml
+
+ 4.0.0
-
-
- org.jetbrains
- annotations
- 24.1.0
-
-
- com.google.guava
- guava
- 33.2.1-android
-
+ database
+ PWDB :: Database
+ Contains root definitions of PWDB Databases etc.
+
+
+
+
+ org.bouncycastle
+ bcpkix-jdk18on
+
- org.bouncycastle
- bcpkix-jdk18on
+
+ commons-io
+ commons-io
-
+
+ com.google.code.findbugs
+ jsr305
+ 3.0.2
+
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-jar-plugin
+
+
+
+ test-jar
+
+
+
+
+
+
\ No newline at end of file
diff --git a/database/src/main/java/org/linguafranca/pwdb/Credentials.java b/database/src/main/java/org/linguafranca/pwdb/Credentials.java
index 7f03b64e..58dc7a5b 100644
--- a/database/src/main/java/org/linguafranca/pwdb/Credentials.java
+++ b/database/src/main/java/org/linguafranca/pwdb/Credentials.java
@@ -1,17 +1,18 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb;
diff --git a/database/src/main/java/org/linguafranca/pwdb/Database.java b/database/src/main/java/org/linguafranca/pwdb/Database.java
index 632f35ae..a92231a7 100644
--- a/database/src/main/java/org/linguafranca/pwdb/Database.java
+++ b/database/src/main/java/org/linguafranca/pwdb/Database.java
@@ -1,22 +1,23 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb;
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
import java.io.IOException;
import java.io.OutputStream;
@@ -49,26 +50,26 @@
* the caller without affecting the underlying database structure, however changes
* to the Groups and Entries contained in the lists do modify the database.
*/
-public interface Database , G extends Group, E extends Entry, I extends Icon> {
+public interface Database {
/**
* get the root group for the database
* @return the root group
*/
- G getRootGroup();
+ Group getRootGroup();
/**
* Create a new Group
* @return the group created
*/
- G newGroup();
+ Group newGroup();
/**
* Create a new named Group
* @param name the name of the group
* @return the group created
*/
- G newGroup(String name);
+ Group newGroup(String name);
/**
* Create a new Group copying the details of the supplied group, but not copying its children
@@ -77,19 +78,19 @@ public interface Database , G extends Group group);
+ Group newGroup(Group group);
/**
* Create a new Entry
* @return the entry created
*/
- E newEntry();
+ Entry newEntry();
/**
* Create a new Entry with a title
* @return the entry created
*/
- E newEntry(String title);
+ Entry newEntry(String title);
/**
* Create a new Entry copying the details of the supplied entry
@@ -98,27 +99,27 @@ public interface Database , G extends Group entry);
+ Entry newEntry(Entry entry);
/**
* Create a new default icon
* @return the created icon
*/
- I newIcon();
+ Icon newIcon();
/**
* Create a new icon with a specified index
* @param i the index of the icon to create
* @return the created icon
*/
- I newIcon(Integer i);
+ Icon newIcon(Integer i);
/**
* Find an entry with this UUID anywhere in the database except the recycle bin
* @param uuid the UUID
* @return an entry or null if not found
*/
- @Nullable E findEntry(UUID uuid);
+ @Nullable Entry findEntry(UUID uuid);
/**
* Delete an entry with this UUID from anywhere in the database except the recycle bin
@@ -133,7 +134,7 @@ public interface Database , G extends Group, G extends Group, G extends Group visitor);
+ void visit(Visitor visitor);
/**
* Visit all entries starting from a group
* @param group the group to start at
* @param visitor the visitor to use
*/
- void visit(G group, Visitor visitor);
+ void visit(Group group, Visitor visitor);
/**
* Find all entries that match the criteria
@@ -192,7 +193,7 @@ public interface Database , G extends Group findEntries(Entry.Matcher matcher);
+ List findEntries(Entry.Matcher matcher);
/**
* Find all entries that match {@link Entry#match(String)}
@@ -200,7 +201,7 @@ public interface Database , G extends Group findEntries(String find);
+ List findEntries(String find);
/**
* Gets the name of the database or null if not supported
@@ -237,10 +238,20 @@ public interface Database , G extends Group void save(StreamFormat streamFormat, Credentials credentials, OutputStream outputStream) throws IOException;
+ /**
+ * Save the database to a stream and closes the stream - avoiding checked exception
+ */
+ void saveNx(StreamFormat streamFormat, Credentials credentials, OutputStream outputStream);
+
/**
* Get the format the database was loaded from
*/
@@ -264,12 +275,13 @@ public interface Database , G extends Group listShouldProtect();
/**
* Get the default means of storage of unprotected and protected property values
*/
- public PropertyValue.Strategy getPropertyValueStrategy();
+ PropertyValue.Strategy getPropertyValueStrategy();
/**
* Set the default means of storage of unprotected and protected property values
diff --git a/database/src/main/java/org/linguafranca/pwdb/Entry.java b/database/src/main/java/org/linguafranca/pwdb/Entry.java
index 2c2a95a3..1d7acf64 100644
--- a/database/src/main/java/org/linguafranca/pwdb/Entry.java
+++ b/database/src/main/java/org/linguafranca/pwdb/Entry.java
@@ -1,23 +1,23 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
import java.util.*;
@@ -43,30 +43,40 @@
*
* @author Jo
*/
-public interface Entry , G extends Group, E extends Entry, I extends Icon> {
+public interface Entry {
/**
* Standard properties are attributes of Entries that are accessible either by
* dedicated methods, such as getPassword, or by {@link #getProperty(String)}
*/
+ String STANDARD_PROPERTY_NAME_TITLE = "Title";
String STANDARD_PROPERTY_NAME_USER_NAME = "UserName";
String STANDARD_PROPERTY_NAME_PASSWORD = "Password";
String STANDARD_PROPERTY_NAME_URL = "URL";
- String STANDARD_PROPERTY_NAME_TITLE = "Title";
String STANDARD_PROPERTY_NAME_NOTES = "Notes";
- List STANDARD_PROPERTY_NAMES = Collections.unmodifiableList(Arrays.asList(
+ /** allows for static import of name */
+ interface STANDARD_PROPERTY_NAME {
+ String TITLE = STANDARD_PROPERTY_NAME_TITLE;
+ String USER_NAME = STANDARD_PROPERTY_NAME_USER_NAME;
+ String PASSWORD = STANDARD_PROPERTY_NAME_PASSWORD;
+ String URL = STANDARD_PROPERTY_NAME_URL;
+ String NOTES = STANDARD_PROPERTY_NAME_NOTES;
+ }
+
+ List STANDARD_PROPERTY_NAMES = List.of(
+ STANDARD_PROPERTY_NAME_TITLE,
STANDARD_PROPERTY_NAME_USER_NAME,
STANDARD_PROPERTY_NAME_PASSWORD,
STANDARD_PROPERTY_NAME_URL,
- STANDARD_PROPERTY_NAME_TITLE,
- STANDARD_PROPERTY_NAME_NOTES));
+ STANDARD_PROPERTY_NAME_NOTES);
/**
* Interface to implement when using the {@link #match(Entry.Matcher)}
* method
*/
interface Matcher {
+ // needs to be raw type so that we can use lambdas
boolean matches(Entry entry);
}
@@ -104,7 +114,7 @@ interface Matcher {
* @return a value or null if the property is not known, or if setting of arbitrary properties is not supported
* @see Database#supportsNonStandardPropertyNames()
*/
- String getProperty(String name);
+ @Nullable String getProperty(String name);
/**
* Gets the value of a property as a PropertyValue.
@@ -118,7 +128,8 @@ interface Matcher {
PropertyValue getPropertyValue(String name);
/**
- * Sets the value of a property. Use of this method is not recommended for fields with protected values.
+ * Sets the value of a property as a String in memory.
+ * Use of this method is not recommended for fields with protected values.
* Use {@link #setPropertyValue(String, PropertyValue)}
*
*
Other than the {@link #STANDARD_PROPERTY_NAMES} support for this method is optional.
@@ -129,10 +140,10 @@ interface Matcher {
* non-standard properties are not supported
* @see Database#supportsNonStandardPropertyNames()
*/
- void setProperty(String name, String value);
+ Entry setProperty(String name, String value);
/**
- * Sets the value of a property as a property value. The method does not check whether the
+ * Sets the value of a property as a property value in memory. The method does not check whether the
* passed PropertyValue is protected relative to {@link Database#shouldProtect(String)}
*
*
Other than the {@link #STANDARD_PROPERTY_NAMES} support for this method is optional.
@@ -143,10 +154,71 @@ interface Matcher {
* non-standard properties are not supported
* @see Database#supportsNonStandardPropertyNames()
*/
- void setPropertyValue(String name, PropertyValue value);
+ Entry setPropertyValue(String name, PropertyValue value);
+
+ /**
+ * Adds (or modifies) the value of a property as a property value in memory. The method uses the
+ * PropertyValue.Strategy to determine how to determine the storage format in memory.
+ *
+ *
Other than the {@link #STANDARD_PROPERTY_NAMES} support for this method is optional.
+ *
+ * @param name the name of the property to set
+ * @param value the value to set it to
+ * @throws UnsupportedOperationException if the name is not one of the standard properties and
+ * non-standard properties are not supported
+ * @see Database#supportsNonStandardPropertyNames()
+ */
+ Entry addProperty(String name, byte[] value);
/**
- * Removes this non-standard property, if it exists.
+ * Adds (or modifies) the value of a property as a property value in memory. The method uses the
+ * PropertyValue.Strategy to determine how to determine the storage format in memory.
+ *
+ *
Other than the {@link #STANDARD_PROPERTY_NAMES} support for this method is optional.
+ *
+ * @param name the name of the property to set
+ * @param value the value to set it to
+ * @throws UnsupportedOperationException if the name is not one of the standard properties and
+ * non-standard properties are not supported
+ * @see Database#supportsNonStandardPropertyNames()
+ */
+ Entry addProperty(String name, char[] value);
+
+ /**
+ * Adds (or modifies) the value of a property as a property value in memory. The method uses the
+ * PropertyValue.Strategy to determine how to determine the storage format in memory.
+ *
+ *
Other than the {@link #STANDARD_PROPERTY_NAMES} support for this method is optional.
+ *
+ * @param name the name of the property to set
+ * @param value the value to set it to
+ * @throws UnsupportedOperationException if the name is not one of the standard properties and
+ * non-standard properties are not supported
+ * @see Database#supportsNonStandardPropertyNames()
+ */
+ Entry addProperty(String name, CharSequence value);
+
+ /**
+ * Adds a newly created entry to the Group parent of the current Entry, if there is one. Intended primary for
+ * fluid building of entries within a group.
+ *
+ * @throws IllegalStateException if there is no parent
+ * @param name the title of the entry
+ * @return the newly created entry
+ */
+ Entry addEntry(String name);
+
+ /**
+ * Adds a newly created entry to the Group parent of the current Entry, if there is one. Intended primary for
+ * fluid building of entries within a group.
+ *
+ * @throws IllegalStateException if there is no parent
+ * @return the newly created entry
+ */
+ Entry addEntry();
+
+ /**
+ * Removes this property, if it exists and if it is a non-standard property
*
* @return true if the property exists and was removed, false otherwise
* @param name the value of the property to remove
@@ -174,7 +246,7 @@ interface Matcher {
* @return a value or null if the property is not known, or if setting of arbitrary properties is not supported
* @see Database#supportsBinaryProperties
*/
- byte[] getBinaryProperty(String name);
+ byte@Nullable [] getBinaryProperty(String name);
/**
* Sets the value of a binary property.
@@ -209,11 +281,17 @@ interface Matcher {
*/
List getBinaryPropertyNames();
+ /**
+ * Get the database this entry belongs to
+ * @return a database
+ */
+ Database getDatabase();
+
/**
* Get the parent of this entry
* @return a parent or null if this entry currently does not have a parent
*/
- @Nullable G getParent();
+ @Nullable Group getParent();
/**
* Get the UUID of this entry. Databases (like KDB) that do not natively support
@@ -221,7 +299,7 @@ interface Matcher {
*
* @return a UUID
*/
- @NotNull UUID getUuid();
+ UUID getUuid();
/**
* Get the username field of this entry
@@ -248,6 +326,7 @@ interface Matcher {
*
Implementations should Touch LastAccessedTime when this method is called.
*
* @return a password
+ * @deprecated use {@link #getPropertyValue(String)} with {@link #STANDARD_PROPERTY_NAME_PASSWORD}
*/
@Deprecated
String getPassword();
@@ -258,7 +337,7 @@ interface Matcher {
*
Implementations should Touch LastModifiedTime when this method is called.
*
* @param pass a password
- * @deprecated use {@link #setPropertyValue(String, PropertyValue)}
+ * @deprecated use {@link #setPropertyValue(String, PropertyValue)} with {@link #STANDARD_PROPERTY_NAME_PASSWORD}
*/
@Deprecated
void setPassword(String pass);
@@ -342,13 +421,13 @@ interface Matcher {
* Returns the {@link Icon} associated with this entry.
* @return an Icon
*/
- I getIcon();
+ Icon getIcon();
/**
* Sets the {@link Icon} associated with this entry.
* @param icon an Icon
*/
- void setIcon(I icon);
+ void setIcon(Icon icon);
/**
* Returns the date at which any value was retrieved from this entry.
diff --git a/database/src/main/java/org/linguafranca/pwdb/Group.java b/database/src/main/java/org/linguafranca/pwdb/Group.java
index 152a3f12..dae9cf23 100644
--- a/database/src/main/java/org/linguafranca/pwdb/Group.java
+++ b/database/src/main/java/org/linguafranca/pwdb/Group.java
@@ -1,23 +1,22 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb;
-import org.jetbrains.annotations.NotNull;
-
import javax.annotation.Nullable;
import java.util.List;
import java.util.UUID;
@@ -37,7 +36,7 @@
*
* @author Jo
*/
-public interface Group , G extends Group, E extends Entry, I extends Icon> {
+public interface Group {
/**
* Returns true if this is the root group of a database
*/
@@ -54,7 +53,7 @@ public interface Group , G extends Group, G extends Group, G extends Group getGroups();
+ List getGroups();
/**
* Returns the number of groups that are direct children of this group
*
*
It's possible that returning a list as in {@link #getGroups()} may incur significantly
- * more overhead so use this method if only the count is reuqired
+ * more overhead so use this method if only the count is required
*/
int getGroupsCount();
@@ -90,7 +89,15 @@ public interface Group , G extends Group, G extends Group findGroups(String groupName);
+ List findGroups(String groupName);
/**
* Removes the group supplied from this group. The group removed
- * no longer has a parent and so in not part of the database any more unless
+ * no longer has a parent and so in no longer part of the database unless
* it is re-added to another group.
*
- * If the group is incompatible with the databse an exception is thrown.
+ * If the group is incompatible with the database an exception is thrown.
*
* If the group is not present no error is thrown.
* @param group the group to remove
* @return the group passed for removal
* @throws IllegalArgumentException if the group is not a child of this group
*/
- G removeGroup(G group);
+ Group removeGroup(Group group);
/**
* Returns a modifiable by the caller list of entries contained in this group.
*/
- List getEntries();
+ List getEntries();
/**
* Returns the number of entries in this group
*
*
It's possible that returning a list as in {@link #getEntries()} may incur significantly
- * more overhead so use this method if only the count is reuqired
+ * more overhead so use this method if only the count is required
*/
int getEntriesCount();
@@ -135,14 +142,14 @@ public interface Group , G extends GroupEntry match is described under {@link Entry#match(String)}
*
- *
Note: finding within recycle bin is supported, recusion into recycle bin is inhibited
+ *
Note: finding within recycle bin is supported, recursion into recycle bin is inhibited
*
* @param match the text to match
- * @param recursive whether to include sub groups in the process
+ * @param recursive whether to include subgroups in the process
* @return a modifiable-by-caller list
* @see Entry#match(String)
*/
- List findEntries(String match, boolean recursive);
+ List findEntries(String match, boolean recursive);
/**
* Finds all entries in this group that match using the matcher supplied.
@@ -150,14 +157,14 @@ public interface Group , G extends GroupEntry match is described under {@link Entry#match(Entry.Matcher)}
*
- *
Note: finding within recycle bin is supported, recusion into recycle bin is inhibited
+ *
Note: finding within recycle bin is supported, recursion into recycle bin is inhibited
*
- * @param matcher the mathcher to use
- * @param recursive whether to include sub groups in the process
+ * @param matcher the matcher to use
+ * @param recursive whether to include subgroups in the process
* @return a modifiable-by-caller list
* @see Entry#match(Entry.Matcher)
*/
- List findEntries(Entry.Matcher matcher, boolean recursive);
+ List findEntries(Entry.Matcher matcher, boolean recursive);
/**
* Adds an entry to this group removing it from another group
@@ -165,7 +172,20 @@ public interface Group , G extends Group, G extends Group parent);
+ void copy(Group parent);
/**
* Returns an XPath-like string of the names of Groups from the Root
@@ -210,10 +230,10 @@ public interface Group , G extends Group getFactoryFor(String prop
newUnprotected();
}
+ /**
+ * The default implementation of the Strategy interface in which the only protected property is Password.
+ * It uses SealedStore and BytesStore for protected and unprotected properties. It is immutable.
+ */
class Default implements Strategy {
@Override
public List getProtectedProperties() {
- //noinspection ArraysAsListWithZeroOrOneArgument
- return new ArrayList<>(Arrays.asList(Entry.STANDARD_PROPERTY_NAME_PASSWORD));
+ return List.of(Entry.STANDARD_PROPERTY_NAME_PASSWORD);
}
@Override
@@ -122,15 +140,31 @@ public Factory newUnprotected() {
return BytesStore.getFactory();
}
}
+
+ /**
+ * A mutable implementation of the Strategy interface, which allows the protected properties to be set.
+ * By default, the only protected property is Password.
+ * It uses SealedStore and BytesStore for protected and unprotected properties.
+ */
+ class MutableProtectionStrategy extends PropertyValue.Strategy.Default {
+ List protectedProperties = new ArrayList<>();
+ {
+ protectedProperties.add(Entry.STANDARD_PROPERTY_NAME_PASSWORD);
+ }
+ @Override
+ public List getProtectedProperties() {
+ return protectedProperties;
+ }
+ }
}
/**
- * Values are stored as strings.
+ * Property Values are stored as strings.
*/
class StringStore implements PropertyValue {
private final String value;
private final static PropertyValue.Factory factory =
- new PropertyValue.Factory(){
+ new PropertyValue.Factory<>(){
@Override
public StringStore of(CharSequence aCharSequence) {
@@ -195,7 +229,7 @@ class BytesStore implements PropertyValue, Serializable {
private final byte[] value;
private final static PropertyValue.Factory factory =
- new PropertyValue.Factory(){
+ new PropertyValue.Factory<>(){
@Override
public BytesStore of(CharSequence aCharSequence) {
@@ -216,6 +250,7 @@ public BytesStore of(byte[] value) {
public static PropertyValue.Factory getFactory() {
return factory;
}
+
public BytesStore(CharSequence aString) {
this.value = charSequenceToBytes(aString);
}
@@ -230,13 +265,13 @@ public BytesStore(byte [] value) {
@Override
public String getValueAsString() {
- return new String(this.value);
+ return new String(this.value, StandardCharsets.UTF_8);
}
@Override
public CharSequence getValue() {
ByteBuffer bb = ByteBuffer.wrap(this.value);
- return Charsets.UTF_8.decode(bb);
+ return StandardCharsets.UTF_8.decode(bb);
}
@Override
@@ -305,7 +340,7 @@ private byte[] getBytes() {
}
private final static PropertyValue.Factory factory =
- new PropertyValue.Factory(){
+ new PropertyValue.Factory<>(){
@Override
public SealedStore of(CharSequence aCharSequence) {
@@ -415,7 +450,7 @@ public SealedStore(CharSequence charSequence) {
@Override
public String getValueAsString() {
- return new String(getBytes());
+ return new String(getBytes(), StandardCharsets.UTF_8);
}
@Override
diff --git a/database/src/main/java/org/linguafranca/pwdb/SerializableDatabase.java b/database/src/main/java/org/linguafranca/pwdb/SerializableDatabase.java
index 74e7a961..a956839e 100644
--- a/database/src/main/java/org/linguafranca/pwdb/SerializableDatabase.java
+++ b/database/src/main/java/org/linguafranca/pwdb/SerializableDatabase.java
@@ -1,17 +1,18 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb;
diff --git a/database/src/main/java/org/linguafranca/pwdb/StreamConfiguration.java b/database/src/main/java/org/linguafranca/pwdb/StreamConfiguration.java
index 4b717495..f6f3709f 100644
--- a/database/src/main/java/org/linguafranca/pwdb/StreamConfiguration.java
+++ b/database/src/main/java/org/linguafranca/pwdb/StreamConfiguration.java
@@ -1,3 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb;
/**
diff --git a/database/src/main/java/org/linguafranca/pwdb/StreamFormat.java b/database/src/main/java/org/linguafranca/pwdb/StreamFormat.java
index bc8779bc..ed006e17 100644
--- a/database/src/main/java/org/linguafranca/pwdb/StreamFormat.java
+++ b/database/src/main/java/org/linguafranca/pwdb/StreamFormat.java
@@ -1,17 +1,18 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb;
diff --git a/database/src/main/java/org/linguafranca/pwdb/Visitor.java b/database/src/main/java/org/linguafranca/pwdb/Visitor.java
index a7e3536b..fe767f41 100644
--- a/database/src/main/java/org/linguafranca/pwdb/Visitor.java
+++ b/database/src/main/java/org/linguafranca/pwdb/Visitor.java
@@ -1,17 +1,18 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb;
@@ -23,24 +24,24 @@
*
* @author jo
*/
-public interface Visitor , G extends Group, E extends Entry, I extends Icon> {
+public interface Visitor {
/**
* Called on entry to a group visit
* @param group the group being visited
*/
- void startVisit(G group);
+ void startVisit(Group group);
/**
* Called on exit from a group visit
* @param group the group being exited
*/
- void endVisit(G group);
+ void endVisit(Group group );
/**
* Called on visit to an entry
* @param entry the entry being visited
*/
- void visit(E entry);
+ void visit(Entry entry);
/**
* called to determine whether to visit entries before subgroups, or not
@@ -51,17 +52,16 @@ public interface Visitor , G extends Group, G extends Group, E extends Entry, I extends Icon>
- implements Visitor {
+ abstract class Default implements Visitor {
@Override
- public void startVisit(G group) {}
+ public void startVisit(Group group) {}
@Override
- public void endVisit(G group) {}
+ public void endVisit(Group group) {}
@Override
- public void visit(E entry) {}
+ public void visit(Entry entry) {}
@Override
public boolean isEntriesFirst() {
@@ -72,8 +72,7 @@ public boolean isEntriesFirst() {
/**
* Visitor prints the Groups and Entries it visits to console
*/
- class Print , G extends Group, E extends Entry, I extends Icon>
- extends Default {
+ class Print extends Default{
private final PrintStream printStream;
@@ -86,12 +85,12 @@ public Print(PrintStream out) {
}
@Override
- public void startVisit(G group) {
+ public void startVisit(Group group ) {
printStream.println(group.toString());
}
@Override
- public void visit(E entry) {
+ public void visit(Entry entry) {
printStream.println(entry.toString());
}
diff --git a/database/src/main/java/org/linguafranca/pwdb/base/AbstractDatabase.java b/database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractDatabase.java
similarity index 74%
rename from database/src/main/java/org/linguafranca/pwdb/base/AbstractDatabase.java
rename to database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractDatabase.java
index e8cada25..03ffb624 100644
--- a/database/src/main/java/org/linguafranca/pwdb/base/AbstractDatabase.java
+++ b/database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractDatabase.java
@@ -1,23 +1,25 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb.base;
+package org.linguafranca.pwdb.abstractdb;
import org.linguafranca.pwdb.*;
+import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
@@ -27,7 +29,7 @@
*
* @author Jo
*/
-public abstract class AbstractDatabase, G extends Group, E extends Entry, I extends Icon> implements Database {
+public abstract class AbstractDatabase implements Database {
private boolean isDirty;
@@ -41,69 +43,69 @@ public void setDirty(boolean dirty) {
}
@Override
- public void visit(Visitor visitor) {
+ public void visit(Visitor visitor) {
visitor.startVisit(getRootGroup());
visit(getRootGroup(), visitor);
visitor.endVisit(getRootGroup());
}
@Override
- public void visit(G group, Visitor visitor) {
+ public void visit(Group group, Visitor visitor) {
if (visitor.isEntriesFirst()) {
- for (E entry : group.getEntries()) {
+ for (Entry entry : group.getEntries()) {
visitor.visit(entry);
}
}
- for (G g : group.getGroups()) {
+ for (Group g : group.getGroups()) {
visitor.startVisit(g);
visit(g, visitor);
visitor.endVisit(g);
}
if (!visitor.isEntriesFirst()) {
- for (E entry : group.getEntries()) {
+ for (Entry entry : group.getEntries()) {
visitor.visit(entry);
}
}
}
@Override
- public List findEntries(Entry.Matcher matcher) {
+ public List findEntries(Entry.Matcher matcher) {
return getRootGroup().findEntries(matcher, true);
}
@Override
- public List findEntries(String find) {
+ public List findEntries(String find) {
return getRootGroup().findEntries(find, true);
}
@Override
- public G newGroup(String name) {
- G result = newGroup();
+ public Group newGroup(String name) {
+ Group result = newGroup();
result.setName(name);
return result;
}
@Override
- public G newGroup(Group group) {
- G result = newGroup();
+ public Group newGroup(Group group) {
+ Group result = newGroup();
result.setName(group.getName());
result.setIcon(this.newIcon(group.getIcon().getIndex()));
return result;
}
@Override
- public E newEntry(String title) {
- E result = newEntry();
+ public Entry newEntry(String title) {
+ Entry result = newEntry();
result.setTitle(title);
return result;
}
@Override
- public E newEntry(Entry entry) {
- E result = newEntry();
+ public Entry newEntry(Entry entry) {
+ Entry result = newEntry();
for (String propertyName: entry.getPropertyNames()) {
try {
// all implementations must support setting of STANDARD_PROPERTY_NAMES
@@ -130,8 +132,8 @@ public E newEntry(Entry entry) {
}
@Override
- public E findEntry(final UUID uuid) {
- List entries = findEntries(entry -> entry.getUuid().equals(uuid));
+ public Entry findEntry(final UUID uuid) {
+ List entries = findEntries(entry -> entry.getUuid().equals(uuid));
if (entries.size() > 1) {
throw new IllegalStateException("Two entries same UUID");
}
@@ -143,7 +145,7 @@ public E findEntry(final UUID uuid) {
@Override
public boolean deleteEntry(final UUID uuid) {
- E e = findEntry(uuid);
+ Entry e = findEntry(uuid);
if (e == null) {
return false;
}
@@ -158,13 +160,13 @@ public boolean deleteEntry(final UUID uuid) {
}
@Override
- public G findGroup(final UUID uuid){
- final List groups = new ArrayList<>();
- visit(new Visitor.Default() {
+ public Group findGroup(final UUID uuid){
+ final List groups = new ArrayList<>();
+ visit(new Visitor.Default() {
// set to true while visiting sub groups of recycle bin
boolean recycle;
@Override
- public void startVisit(G group) {
+ public void startVisit(Group group) {
if (!recycle && group.getUuid().equals(uuid)) {
groups.add(group);
}
@@ -174,7 +176,7 @@ public void startVisit(G group) {
}
@Override
- public void endVisit(G group) {
+ public void endVisit(Group group) {
if (group.isRecycleBin()) {
recycle = false;
}
@@ -191,7 +193,7 @@ public void endVisit(G group) {
@Override
public boolean deleteGroup(final UUID uuid) {
- G g = findGroup(uuid);
+ Group g = findGroup(uuid);
if (g==null) {
return false;
}
@@ -207,14 +209,14 @@ public boolean deleteGroup(final UUID uuid) {
@Override
public void emptyRecycleBin() {
- G recycle = getRecycleBin();
+ Group recycle = getRecycleBin();
if (recycle == null) {
return;
}
- for (G g: recycle.getGroups()){
+ for (Group g: recycle.getGroups()){
recycle.removeGroup(g);
}
- for (E e: recycle.getEntries()){
+ for (Entry e: recycle.getEntries()){
recycle.removeEntry(e);
}
}
@@ -231,7 +233,7 @@ public boolean supportsBinaryProperties() {
@Override
public boolean supportsRecycleBin() {
- return true;
+ return false;
}
@Override
@@ -262,4 +264,21 @@ public boolean supportsPropertyValueStrategy(){
return false;
}
+ @Override
+ public void saveNx(Credentials credentials, OutputStream outputStream) {
+ try {
+ save(credentials, outputStream);
+ } catch (Exception e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ @Override
+ public void saveNx(StreamFormat streamFormat, Credentials credentials, OutputStream outputStream) {
+ try {
+ save(streamFormat, credentials, outputStream);
+ } catch (Exception e) {
+ throw new RuntimeException(e);
+ }
+ }
}
diff --git a/database/src/main/java/org/linguafranca/pwdb/base/AbstractEntry.java b/database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractEntry.java
similarity index 75%
rename from database/src/main/java/org/linguafranca/pwdb/base/AbstractEntry.java
rename to database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractEntry.java
index 47f233d2..145617f1 100644
--- a/database/src/main/java/org/linguafranca/pwdb/base/AbstractEntry.java
+++ b/database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractEntry.java
@@ -1,20 +1,21 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb.base;
+package org.linguafranca.pwdb.abstractdb;
import org.linguafranca.pwdb.*;
@@ -23,7 +24,7 @@
*
* @author Jo
*/
-public abstract class AbstractEntry, G extends Group, E extends Entry, I extends Icon> implements Entry {
+public abstract class AbstractEntry implements Entry {
@Override
public boolean matchTitle(String text){
@@ -57,7 +58,7 @@ public boolean match(Entry.Matcher matcher) {
@Override
public String getPath() {
- G parent = this.getParent();
+ Group parent = this.getParent();
String result = "";
if (parent != null) {
result = parent.getPath();
@@ -130,9 +131,34 @@ public PropertyValue getPropertyValue(String name) {
}
@Override
- public void setPropertyValue(String name, PropertyValue value) {
+ public Entry setPropertyValue(String name, PropertyValue value) {
+ throw new UnsupportedOperationException();
+ }
+
+ public Entry addProperty(String name, byte[] value){
+ throw new UnsupportedOperationException();
+ }
+ public Entry addProperty(String name, char[] value){
+ throw new UnsupportedOperationException();
+ }
+ public Entry addProperty(String name, CharSequence value){
throw new UnsupportedOperationException();
}
+ public Entry addEntry(){
+ if (this.getParent()!=null) {
+ return this.getParent().addEntry();
+ }
+ throw new IllegalStateException("Entry has no group parent");
+ }
+
+ public Entry addEntry(String title){
+ if (this.getParent()!=null) {
+ return this.getParent().addEntry(title);
+ }
+ throw new IllegalStateException("Entry has no group parent");
+ }
+
+
protected abstract void touch();
}
diff --git a/database/src/main/java/org/linguafranca/pwdb/base/AbstractGroup.java b/database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractGroup.java
similarity index 52%
rename from database/src/main/java/org/linguafranca/pwdb/base/AbstractGroup.java
rename to database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractGroup.java
index cf13c0af..6a4c5f48 100644
--- a/database/src/main/java/org/linguafranca/pwdb/base/AbstractGroup.java
+++ b/database/src/main/java/org/linguafranca/pwdb/abstractdb/AbstractGroup.java
@@ -1,25 +1,24 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb.base;
+package org.linguafranca.pwdb.abstractdb;
-import org.linguafranca.pwdb.Database;
import org.linguafranca.pwdb.Entry;
import org.linguafranca.pwdb.Group;
-import org.linguafranca.pwdb.Icon;
import java.util.ArrayList;
import java.util.List;
@@ -30,52 +29,52 @@
*
* @author Jo
*/
-public abstract class AbstractGroup, G extends org.linguafranca.pwdb.base.AbstractGroup, E extends Entry, I extends Icon> implements Group {
+public abstract class AbstractGroup implements Group {
@Override
- public List findGroups(String group1) {
- ArrayList result = new ArrayList<>();
- for (G g: getGroups()) {
- if (g.getName().equals(group1)) {
- result.add(g);
- }
- }
- return result;
+ public Entry addEntry() {
+ Entry entry = getDatabase().newEntry();
+ return addEntry(entry);
}
@Override
- public List findEntries(String find, boolean recursive) {
- /*
- * Local helper class to avoid violating DRY in {@link AbstractGroup#findEntries(String, boolean)}.
- * Would-be lambda in Java 8.
- */
- class TextMatcher implements Entry.Matcher {
-
- private final String text;
+ public Entry addEntry(String title) {
+ Entry entry = getDatabase().newEntry(title);
+ return addEntry(entry);
+ }
- private TextMatcher(String text) {
- this.text = text;
- }
+ @Override
+ public Group addGroup(String name) {
+ Group group = getDatabase().newGroup(name);
+ return addGroup(group);
+ }
- @Override
- public boolean matches(Entry entry) {
- return entry.match(text);
+ @Override
+ public List findGroups(String group) {
+ ArrayList result = new ArrayList<>();
+ for (Group g: getGroups()) {
+ if (g.getName().equals(group)) {
+ result.add(g);
}
}
+ return result;
+ }
- return findEntries(new TextMatcher(find), recursive);
+ @Override
+ public List findEntries(String find, boolean recursive) {
+ return findEntries(entry -> entry.match(find), recursive);
}
@Override
- public List findEntries(Entry.Matcher matcher, boolean recursive) {
- List result = new ArrayList<>(getEntries().size());
- for (E entry: getEntries()){
+ public List findEntries(Entry.Matcher matcher, boolean recursive) {
+ List result = new ArrayList<>(getEntries().size());
+ for (Entry entry: getEntries()){
if (entry.match(matcher)){
result.add(entry);
}
}
if (recursive) {
- for (G group : getGroups()) {
+ for (Group group: getGroups()) {
// don't recurse into recycle bin
if (group.isRecycleBin()) {
continue;
@@ -87,9 +86,9 @@ public List findEntries(Entry.Matcher matcher, boolean recursive) {
}
@Override
- public void copy(Group parent) {
- for (Group child : parent.getGroups()) {
- G addedGroup = addGroup(this.getDatabase().newGroup(child));
+ public void copy(Group parent) {
+ for (Group child : parent.getGroups()) {
+ Group addedGroup = addGroup(this.getDatabase().newGroup(child));
addedGroup.copy(child);
}
for (Entry entry : parent.getEntries()) {
@@ -106,7 +105,7 @@ public String getPath() {
parents.push(parent);
}
StringBuilder result = new StringBuilder("/");
- while (parents.size() > 0) {
+ while (!parents.isEmpty()) {
result.append(parents.pop().getName()).append("/");
}
return result.toString();
diff --git a/database/src/main/java/org/linguafranca/pwdb/abstractdb/package-info.java b/database/src/main/java/org/linguafranca/pwdb/abstractdb/package-info.java
new file mode 100644
index 00000000..6aafe5e8
--- /dev/null
+++ b/database/src/main/java/org/linguafranca/pwdb/abstractdb/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+@NullMarked
+package org.linguafranca.pwdb.abstractdb;
+
+import org.jspecify.annotations.NullMarked;
\ No newline at end of file
diff --git a/jackson/src/test/java/org/linguafranca/pwdb/JacksonRecycleBinTest.java b/database/src/main/java/org/linguafranca/pwdb/package-info.java
similarity index 54%
rename from jackson/src/test/java/org/linguafranca/pwdb/JacksonRecycleBinTest.java
rename to database/src/main/java/org/linguafranca/pwdb/package-info.java
index fc63749d..bf6b8ed1 100644
--- a/jackson/src/test/java/org/linguafranca/pwdb/JacksonRecycleBinTest.java
+++ b/database/src/main/java/org/linguafranca/pwdb/package-info.java
@@ -1,31 +1,28 @@
/*
- * Copyright 2023 Giuseppe Valente
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb;
-
-import org.linguafranca.pwdb.checks.RecycleBinChecks;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-public class JacksonRecycleBinTest extends RecycleBinChecks {
+/**
+ * This package contains the interfaces that define the org.linguafranca Database API.
+ *
+ * The API is designed to be a simple, low-level, read-write API for password databases.
+ *
+ * Class instances of the interfaces are contained in the sub-packages of this package.
+ */
+@NullMarked
+package org.linguafranca.pwdb;
- public JacksonRecycleBinTest() {
- try {
- database = new JacksonDatabase();
- } catch(Exception e) {
- e.printStackTrace();
- }
-
- }
-}
+import org.jspecify.annotations.NullMarked;
\ No newline at end of file
diff --git a/database/src/main/java/org/linguafranca/pwdb/protect/ProtectedDatabase.java b/database/src/main/java/org/linguafranca/pwdb/protect/ProtectedDatabase.java
index 7c50e16c..200f6209 100644
--- a/database/src/main/java/org/linguafranca/pwdb/protect/ProtectedDatabase.java
+++ b/database/src/main/java/org/linguafranca/pwdb/protect/ProtectedDatabase.java
@@ -1,7 +1,25 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.protect;
-import org.linguafranca.pwdb.*;
-import org.linguafranca.pwdb.base.AbstractDatabase;
+import org.linguafranca.pwdb.Entry;
+import org.linguafranca.pwdb.PropertyValue;
+import org.linguafranca.pwdb.abstractdb.AbstractDatabase;
import java.util.Collections;
import java.util.List;
@@ -10,28 +28,30 @@
* Base class for Databases which support storage using {@link PropertyValue}s.
*
* By default {@link Entry#STANDARD_PROPERTY_NAME_PASSWORD} is defined as protected and the property value strategy
- * establishes {@link org.linguafranca.pwdb.PropertyValue.StringStore} storage for unprotected values and
+ * establishes {@link org.linguafranca.pwdb.PropertyValue.BytesStore} storage for unprotected values and
* {@link org.linguafranca.pwdb.PropertyValue.SealedStore} for protected values.
*/
-public abstract class ProtectedDatabase, G extends Group, E extends Entry, I extends Icon> extends AbstractDatabase {
+public abstract class ProtectedDatabase extends AbstractDatabase {
private PropertyValue.Strategy valueStrategy = new PropertyValue.Strategy.Default();
@Override
- public boolean shouldProtect(String propertyName){
+ public boolean shouldProtect(String propertyName) {
return valueStrategy.getProtectedProperties().contains(propertyName);
}
@Override
- public void setShouldProtect(String propertyName, boolean protect){
+ public void setShouldProtect(String propertyName, boolean protect) {
if (protect) {
- valueStrategy.getProtectedProperties().add(propertyName);
+ if (!valueStrategy.getProtectedProperties().contains(propertyName)) {
+ valueStrategy.getProtectedProperties().add(propertyName);
+ }
} else {
valueStrategy.getProtectedProperties().remove(propertyName);
}
}
@Override
- public List listShouldProtect(){
+ public List listShouldProtect() {
return Collections.unmodifiableList(valueStrategy.getProtectedProperties());
}
@@ -39,20 +59,22 @@ public List listShouldProtect(){
* Get the default means of storage of unprotected and protected property values
*/
@Override
- public PropertyValue.Strategy getPropertyValueStrategy(){
+ public PropertyValue.Strategy getPropertyValueStrategy() {
return this.valueStrategy;
}
+
/**
* Set the default means of storage of unprotected and protected property values
+ *
* @param strategy a property value strategy
*/
@Override
- public void setPropertyValueStrategy(PropertyValue.Strategy strategy){
+ public void setPropertyValueStrategy(PropertyValue.Strategy strategy) {
this.valueStrategy = strategy;
}
@Override
- public boolean supportsPropertyValueStrategy(){
+ public boolean supportsPropertyValueStrategy() {
return true;
}
}
diff --git a/database/src/main/java/org/linguafranca/pwdb/protect/package-info.java b/database/src/main/java/org/linguafranca/pwdb/protect/package-info.java
new file mode 100644
index 00000000..acad64db
--- /dev/null
+++ b/database/src/main/java/org/linguafranca/pwdb/protect/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+@NullMarked
+package org.linguafranca.pwdb.protect;
+
+import org.jspecify.annotations.NullMarked;
\ No newline at end of file
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/Aes.java b/database/src/main/java/org/linguafranca/pwdb/security/Aes.java
index 776cf39e..529b07c2 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/Aes.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/Aes.java
@@ -1,3 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.security;
import org.bouncycastle.crypto.engines.AESEngine;
@@ -22,7 +39,12 @@
* AES may be used for Key Derivation and also as the underlying stream cipher
*
* The class is a singleton
+ *
+ * {@implNote This class is a singleton}
+ * {@implNote Warnings for the use of AES CBC etc. noted, however their continuing use is required for
+ * compatibility / interoperability with existing databases}
*/
+@SuppressWarnings({"deprecation"})
public class Aes implements CipherAlgorithm, KeyDerivationFunction {
/** UUID specifying that AES is to be used as the Key Derivation Function in KDBX */
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/Argon2.java b/database/src/main/java/org/linguafranca/pwdb/security/Argon2.java
index a0ba2984..09d59494 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/Argon2.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/Argon2.java
@@ -1,3 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.security;
import org.bouncycastle.crypto.generators.Argon2BytesGenerator;
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/ChaCha.java b/database/src/main/java/org/linguafranca/pwdb/security/ChaCha.java
index 65ad1f5b..fd281032 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/ChaCha.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/ChaCha.java
@@ -1,3 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.security;
import org.bouncycastle.crypto.StreamCipher;
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/CipherAlgorithm.java b/database/src/main/java/org/linguafranca/pwdb/security/CipherAlgorithm.java
index bb1a1c0a..e1bc5524 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/CipherAlgorithm.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/CipherAlgorithm.java
@@ -1,3 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.security;
import java.io.InputStream;
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/Encryption.java b/database/src/main/java/org/linguafranca/pwdb/security/Encryption.java
index 36d4a46e..32f9fdf8 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/Encryption.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/Encryption.java
@@ -1,17 +1,18 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb.security;
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/KeyDerivationFunction.java b/database/src/main/java/org/linguafranca/pwdb/security/KeyDerivationFunction.java
index 0e15663f..529dcfe8 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/KeyDerivationFunction.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/KeyDerivationFunction.java
@@ -1,3 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.security;
import java.util.UUID;
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/StreamEncryptor.java b/database/src/main/java/org/linguafranca/pwdb/security/StreamEncryptor.java
index b3fc4a15..e8827590 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/StreamEncryptor.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/StreamEncryptor.java
@@ -1,17 +1,18 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb.security;
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/VariantDictionary.java b/database/src/main/java/org/linguafranca/pwdb/security/VariantDictionary.java
index 0a95db47..1738fb3b 100644
--- a/database/src/main/java/org/linguafranca/pwdb/security/VariantDictionary.java
+++ b/database/src/main/java/org/linguafranca/pwdb/security/VariantDictionary.java
@@ -1,7 +1,23 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.security;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
import javax.annotation.concurrent.Immutable;
import java.nio.ByteBuffer;
@@ -10,7 +26,7 @@
import java.util.Map;
import java.util.UUID;
-import static com.google.common.base.Preconditions.checkNotNull;
+import static java.util.Objects.requireNonNull;
import static org.linguafranca.pwdb.security.VariantDictionary.EntryType.*;
/**
@@ -62,16 +78,16 @@ public static EntryType get(byte type) {
@Immutable
public static class Entry {
private final byte type;
- private final byte @NotNull [] value;
+ private final byte [] value;
private final ByteOrder byteOrder;
- public Entry(EntryType entryType, byte @NotNull [] value) {
+ public Entry(EntryType entryType, byte[] value) {
this(entryType, value, ByteOrder.LITTLE_ENDIAN);
}
- public Entry(EntryType entryType, byte @NotNull [] value, ByteOrder byteOrder) {
+ public Entry(EntryType entryType, byte[] value, ByteOrder byteOrder) {
this.type = entryType.value;
- this.value = checkNotNull(value, vnn);
+ this.value = requireNonNull(value, vnn);
this.byteOrder = byteOrder;
}
@@ -101,7 +117,7 @@ public int asInteger() {
return ByteBuffer.wrap(value).order(byteOrder).getInt();
}
- public byte @NotNull [] asByteArray() {
+ public byte[] asByteArray() {
return value;
}
}
@@ -147,7 +163,7 @@ public short getVersion() {
* @param key the key
* @return an entry, or null if no such entry exists
*/
- public @Nullable Entry get(@NotNull String key) {
+ public @Nullable Entry get(String key) {
return entries.get(key);
}
@@ -157,7 +173,7 @@ public short getVersion() {
* @param key the key to get
* @return the entry corresponding to the key
*/
- public @NotNull Entry mustGet(@NotNull String key) {
+ public Entry mustGet(String key) {
Entry entry = entries.get(key);
if (entry == null) {
throw new IllegalArgumentException("There is no entry with key " + key);
@@ -172,57 +188,57 @@ public short getVersion() {
* @param type the data type of the entry
* @param value a buffer containing an appropriate entry
*/
- public void put(@NotNull String key, EntryType type, byte @NotNull [] value) {
- entries.put(checkNotNull(key), new Entry(type, checkNotNull(value)));
+ public void put(String key, EntryType type, byte[] value) {
+ entries.put(requireNonNull(key), new Entry(type, requireNonNull(value)));
}
/**
* Put a UUID under the key defined
*/
- public void putUuid(@NotNull String key, UUID uuid) {
+ public void putUuid(String key, UUID uuid) {
byte[] buf = new byte[16];
ByteBuffer bb = ByteBuffer.wrap(buf);
bb.putLong(0, uuid.getMostSignificantBits());
bb.putLong(8, uuid.getLeastSignificantBits());
- entries.put(checkNotNull(key, knn), new Entry(ARRAY, buf));
+ entries.put(requireNonNull(key, knn), new Entry(ARRAY, buf));
}
/**
* Put a byte array under the key defined
*/
- public void putByteArray(@NotNull String key, byte @NotNull [] value) {
- entries.put(checkNotNull(key, knn), new Entry(ARRAY, value));
+ public void putByteArray(String key, byte[] value) {
+ entries.put(requireNonNull(key, knn), new Entry(ARRAY, value));
}
/**
* Put a long as a signed64 under the key defined
*/
- public void putLong(@NotNull String key, long value) {
+ public void putLong(String key, long value) {
byte[] buf = new byte[8];
ByteBuffer bb = ByteBuffer.wrap(buf).order(ByteOrder.LITTLE_ENDIAN);
bb.putLong(value);
- entries.put(checkNotNull(key, knn), new Entry(INT64, buf));
+ entries.put(requireNonNull(key, knn), new Entry(INT64, buf));
}
/**
* Put a long as an unsigned64 under the key defined
*/
- public void putULong(@NotNull String key, long value) {
+ public void putULong(String key, long value) {
byte[] buf = new byte[8];
ByteBuffer bb = ByteBuffer.wrap(buf).order(ByteOrder.LITTLE_ENDIAN);
bb.putLong(value);
- entries.put(checkNotNull(key, knn), new Entry(UINT64, buf));
+ entries.put(requireNonNull(key, knn), new Entry(UINT64, buf));
}
- public void putInt(@NotNull String key, int value) {
+ public void putInt(String key, int value) {
byte[] buf = new byte[4];
ByteBuffer bb = ByteBuffer.wrap(buf).order(ByteOrder.LITTLE_ENDIAN);
bb.putInt(value);
- entries.put(checkNotNull(key, knn), new Entry(INT32, buf));
+ entries.put(requireNonNull(key, knn), new Entry(INT32, buf));
}
- public void putUInt(@NotNull String key, int value) {
+ public void putUInt(String key, int value) {
byte[] buf = new byte[4];
ByteBuffer bb = ByteBuffer.wrap(buf).order(ByteOrder.LITTLE_ENDIAN);
bb.putInt(value);
- entries.put(checkNotNull(key, knn), new Entry(UINT32, buf));
+ entries.put(requireNonNull(key, knn), new Entry(UINT32, buf));
}
}
diff --git a/database/src/main/java/org/linguafranca/pwdb/security/package-info.java b/database/src/main/java/org/linguafranca/pwdb/security/package-info.java
new file mode 100644
index 00000000..61951d71
--- /dev/null
+++ b/database/src/main/java/org/linguafranca/pwdb/security/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+@NullMarked
+package org.linguafranca.pwdb.security;
+
+import org.jspecify.annotations.NullMarked;
\ No newline at end of file
diff --git a/database/src/main/java/org/linguafranca/util/MavenRunListener.java b/database/src/main/java/org/linguafranca/util/MavenRunListener.java
deleted file mode 100644
index 1839a645..00000000
--- a/database/src/main/java/org/linguafranca/util/MavenRunListener.java
+++ /dev/null
@@ -1,55 +0,0 @@
-package org.linguafranca.util;
-
-import org.junit.runner.Description;
-import org.junit.runner.notification.Failure;
-import org.junit.runner.notification.RunListener;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.slf4j.Marker;
-import org.slf4j.MarkerFactory;
-
-/**
- * Helper class to identify the test being run by maven surefire in the log output. This
- * is particularly useful if there is a lot of "chatty" testing going on.
- *
- * See: Using Custom Listeners and Reporters
- */
-@RunListener.ThreadSafe
-public class MavenRunListener extends RunListener {
- static Logger logger = LoggerFactory.getLogger("MavenRunListener");
- static Marker marker = MarkerFactory.getMarker("Starting Test");
- static Marker endMarker = MarkerFactory.getMarker("Finished Test");
- static Marker failMarker = MarkerFactory.getMarker("Failed Test");
- static Marker assumeFailMarker = MarkerFactory.getMarker("Assumption Failed");
- static Marker ignoredMarker = MarkerFactory.getMarker("Ignored Test");
-
- @Override
- public void testStarted(Description description) throws Exception {
- super.testStarted(description);
- logger.info(marker, "{}", description.getDisplayName());
- }
-
- @Override
- public void testFailure(Failure failure) throws Exception {
- super.testFailure(failure);
- logger.error(failMarker, "{} {}", failure.getMessage(), failure.getDescription().getDisplayName());
- }
-
- @Override
- public void testAssumptionFailure(Failure failure) {
- super.testAssumptionFailure(failure);
- logger.warn(assumeFailMarker, "{} {}", failure.getMessage(), failure.getDescription().getDisplayName());
- }
-
- @Override
- public void testIgnored(Description description) throws Exception {
- super.testIgnored(description);
- logger.info(ignoredMarker, "{}", description.getDisplayName());
- }
-
- @Override
- public void testFinished(Description description) throws Exception {
- super.testFinished(description);
- logger.info(endMarker, "Finished {}", description.getDisplayName());
- }
-}
diff --git a/database/src/test/java/org/linguafranca/pwdb/PropertyValueTest.java b/database/src/test/java/org/linguafranca/pwdb/PropertyValueTest.java
index 21918401..1ba29d4f 100644
--- a/database/src/test/java/org/linguafranca/pwdb/PropertyValueTest.java
+++ b/database/src/test/java/org/linguafranca/pwdb/PropertyValueTest.java
@@ -1,86 +1,52 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb;
-import org.junit.Test;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
import java.nio.charset.StandardCharsets;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
+import static org.linguafranca.pwdb.PropertyValueUtil.genericTest;
+
+@Execution(CONCURRENT)
public class PropertyValueTest {
- public static final String THIS_IS_A_SECRET = "This is a secret + לַחַיִּים";
public static final String ANOTHER_SECRET = "password with accents àéç";
- Logger logger = LoggerFactory.getLogger(PropertyValueTest.class);
@Test
public void bytesTest() {
- PropertyValue.BytesStore.Factory factory = PropertyValue.BytesStore.getFactory();
-
- // test as CharSequence
- PropertyValue.BytesStore testValue = factory.of(THIS_IS_A_SECRET);
- assertEquals(THIS_IS_A_SECRET, testValue.getValue().toString());
- assertEquals(THIS_IS_A_SECRET, testValue.getValueAsString());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), testValue.getValueAsChars());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(StandardCharsets.UTF_8), testValue.getValueAsBytes());
- // test as char[]
- testValue = factory.of(THIS_IS_A_SECRET.toCharArray());
- assertEquals(THIS_IS_A_SECRET, testValue.getValue().toString());
- assertEquals(THIS_IS_A_SECRET, testValue.getValueAsString());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), testValue.getValueAsChars());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(StandardCharsets.UTF_8), testValue.getValueAsBytes());
- // test as byte[]
- testValue = factory.of(THIS_IS_A_SECRET.getBytes());
- assertEquals(THIS_IS_A_SECRET, testValue.getValue().toString());
- assertEquals(THIS_IS_A_SECRET, testValue.getValueAsString());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), testValue.getValueAsChars());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(StandardCharsets.UTF_8), testValue.getValueAsBytes());
+ genericTest(PropertyValue.BytesStore.getFactory());
}
@Test
public void sealedObjectTest() {
- PropertyValue.SealedStore.Factory factory = PropertyValue.SealedStore.getFactory();
-
- PropertyValue.SealedStore sealed = factory.of(THIS_IS_A_SECRET);
- assertEquals(THIS_IS_A_SECRET, sealed.getValue().toString());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(), sealed.getValueAsBytes());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), sealed.getValueAsChars());
- assertEquals(THIS_IS_A_SECRET, sealed.getValueAsString());
-
- sealed = factory.of(THIS_IS_A_SECRET.getBytes());
- assertEquals(THIS_IS_A_SECRET, sealed.getValue().toString());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(), sealed.getValueAsBytes());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), sealed.getValueAsChars());
- assertEquals(THIS_IS_A_SECRET, sealed.getValueAsString());
-
- sealed =factory.of(THIS_IS_A_SECRET.toCharArray());
- assertEquals(THIS_IS_A_SECRET, sealed.getValue().toString());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(), sealed.getValueAsBytes());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), sealed.getValueAsChars());
- assertEquals(THIS_IS_A_SECRET, sealed.getValueAsString());
+ genericTest(PropertyValue.SealedStore.getFactory());
}
+
@Test
public void stringTest() {
- PropertyValue.Factory factory = PropertyValue.StringStore.getFactory();
-
- PropertyValue.StringStore stringStore = factory.of(THIS_IS_A_SECRET);
- assertEquals(THIS_IS_A_SECRET, stringStore.getValue());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(), stringStore.getValueAsBytes());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), stringStore.getValueAsChars());
- assertEquals(THIS_IS_A_SECRET, stringStore.getValueAsString());
-
- stringStore = factory.of(THIS_IS_A_SECRET.getBytes());
- assertEquals(THIS_IS_A_SECRET, stringStore.getValue());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(), stringStore.getValueAsBytes());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), stringStore.getValueAsChars());
- assertEquals(THIS_IS_A_SECRET, stringStore.getValueAsString());
-
- stringStore =factory.of(THIS_IS_A_SECRET.toCharArray());
- assertEquals(THIS_IS_A_SECRET, stringStore.getValue());
- assertArrayEquals(THIS_IS_A_SECRET.getBytes(), stringStore.getValueAsBytes());
- assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), stringStore.getValueAsChars());
- assertEquals(THIS_IS_A_SECRET, stringStore.getValueAsString());
+ genericTest(PropertyValue.StringStore.getFactory());
}
@Test
@@ -88,31 +54,5 @@ public void sealedScriptTest(){
PropertyValue.SealedStore sealed = PropertyValue.SealedStore.getFactory().of(ANOTHER_SECRET);
byte[] bytes = sealed.getValueAsBytes();
assertArrayEquals(ANOTHER_SECRET.getBytes(StandardCharsets.UTF_8), bytes);
-
- }
-
- @Test
- public void getCharsTest(){
- PropertyValue.BytesStore cs = new PropertyValue.BytesStore("a test".toCharArray());
- char [] value = cs.getValueAsChars();
- value[0] = 'b';
- // changing the retrieved copy doesn't change the source
- assertArrayEquals("a test".toCharArray(), cs.getValueAsChars());
-
- byte [] bytes = cs.getValueAsBytes();
- bytes [0] = 0;
- // same for bytes
- assertArrayEquals("a test".getBytes(), cs.getValueAsBytes());
- }
-
- @Test
- public void putCharsTest(){
- String testValue = "a test";
- char [] chars = testValue.toCharArray();
- PropertyValue.BytesStore cs = new PropertyValue.BytesStore(chars);
- chars[0] = 'b';
- char [] value = cs.getValueAsChars();
- // changing the source doesn't change the copy
- assertArrayEquals(testValue.toCharArray(), cs.getValueAsChars());
}
}
\ No newline at end of file
diff --git a/database/src/test/java/org/linguafranca/pwdb/PropertyValueUtil.java b/database/src/test/java/org/linguafranca/pwdb/PropertyValueUtil.java
new file mode 100644
index 00000000..ee85aae9
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/pwdb/PropertyValueUtil.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb;
+
+import java.nio.charset.StandardCharsets;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * Make available as a utility to provide for PropertyValue extension implementations
+ */
+public class PropertyValueUtil {
+
+ public static final String THIS_IS_A_SECRET = "This is a secret + לַחַיִּים";
+
+ public static void genericTest(PropertyValue.Factory factory) {
+ genericTest(factory, true);
+ }
+
+ public static void genericTest(PropertyValue.Factory factory, boolean testStringReturn) {
+ // test input CharSequence
+ PropertyValue testValue = factory.of(THIS_IS_A_SECRET);
+ test(testStringReturn, testValue);
+
+ // test input char[]
+ testValue = factory.of(THIS_IS_A_SECRET.toCharArray());
+ test(testStringReturn, testValue);
+
+
+ // test input byte[]
+ testValue = factory.of(THIS_IS_A_SECRET.getBytes(StandardCharsets.UTF_8));
+ test(testStringReturn, testValue);
+
+ }
+
+ private static void test(boolean testStringReturn, PropertyValue testValue) {
+ if (testStringReturn) assertEquals(THIS_IS_A_SECRET, testValue.getValue().toString());
+ assertEquals(THIS_IS_A_SECRET, testValue.getValueAsString());
+
+ // get value as chars
+ char[] chars = testValue.getValueAsChars();
+ // return value is correct
+ assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), chars);
+ chars[0] = 'z';
+ // return value is still correct
+ assertArrayEquals(THIS_IS_A_SECRET.toCharArray(), testValue.getValueAsChars());
+
+
+ // get value as bytes
+ byte[] bytes = testValue.getValueAsBytes();
+ // return value is correct
+ assertArrayEquals(THIS_IS_A_SECRET.getBytes(StandardCharsets.UTF_8), bytes);
+ bytes[0] = 'z';
+ // return value is still correct
+ assertArrayEquals(THIS_IS_A_SECRET.getBytes(StandardCharsets.UTF_8), testValue.getValueAsBytes());
+ }
+
+}
diff --git a/database/src/test/java/org/linguafranca/pwdb/test/BinaryPropertiesTest.java b/database/src/test/java/org/linguafranca/pwdb/test/BinaryPropertiesTest.java
new file mode 100644
index 00000000..049ec6f0
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/pwdb/test/BinaryPropertiesTest.java
@@ -0,0 +1,186 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.test;
+
+import org.apache.commons.io.IOUtils;
+import org.junit.jupiter.api.Test;
+import org.linguafranca.pwdb.Database;
+import org.linguafranca.pwdb.Entry;
+import org.linguafranca.pwdb.KdbConsts;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+
+public interface BinaryPropertiesTest {
+
+ Supplier getDbFunc();
+
+ /**
+ * Verify that the database correctly reports that its supports binary attachments - override for
+ * databases that don't
+ */
+ @Test
+ default void checkSupported() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Database database = db.getDatabase();
+ assertTrue(database.supportsBinaryProperties());
+ }
+
+ /**
+ * Retrieve and verify attachment "letter J"
+ */
+ @Test
+ default void getBinaryProperty() throws Exception {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry entry = db.getDatabase().findEntries("Test attachment").get(0);
+ byte[] letterJ = entry.getBinaryProperty("letter J.jpeg");
+ InputStream testFile = getClass().getClassLoader().getResourceAsStream("letter J.jpeg");
+ assert testFile != null;
+ byte[] original = IOUtils.toByteArray(testFile);
+ assertArrayEquals(original, letterJ);
+ }
+
+ /**
+ * Retrieve and verify attachment "letter L"
+ */
+ @Test
+ default void getAnotherBinaryProperty() throws Exception {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry entry = db.getDatabase().findEntries("Test 2 attachment").get(0);
+ byte[] letterL = entry.getBinaryProperty("letter L.jpeg");
+ InputStream testFile = getClass().getClassLoader().getResourceAsStream("letter L.jpeg");
+ assert testFile != null;
+ byte[] original = IOUtils.toByteArray(testFile);
+ assertArrayEquals(original, letterL);
+ }
+
+ /**
+ * Add the Letter L to the entry containing letter J
+ */
+ @Test
+ default void setBinaryProperty() throws Exception {
+ DatabaseTestBase db = getDbFunc().get();
+
+ InputStream testFile = getClass().getClassLoader().getResourceAsStream("letter L.jpeg");
+ assert testFile != null;
+ byte[] original = IOUtils.toByteArray(testFile);
+ Entry entry = db.getDatabase().findEntries("Test attachment").get(0);
+ entry.setBinaryProperty("letter L.jpeg", original);
+ byte[] letterL = entry.getBinaryProperty("letter L.jpeg");
+ assertArrayEquals(original, letterL);
+ assertArrayEquals(new String[]{"letter J.jpeg", "letter L.jpeg"}, entry.getBinaryPropertyNames().toArray());
+ assertTrue(db.getDatabase().isDirty());
+ }
+
+ /**
+ * Verify that the entries have the right attachments
+ */
+ @Test
+ default void getBinaryPropertyNames() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry entry = db.getDatabase().findEntries("Test attachment").get(0);
+ assertArrayEquals(new String[]{"letter J.jpeg"}, entry.getBinaryPropertyNames().toArray());
+
+ entry = db.getDatabase().findEntries("Test 2 attachment").get(0);
+ assertArrayEquals(new String[]{"letter J.jpeg", "letter L.jpeg"}, entry.getBinaryPropertyNames().toArray());
+ }
+
+ /**
+ * Verify that the binary properties can be added and removed correctly
+ */
+ @Test
+ default void checkAddChangeRemoveBinaryProperty() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ byte[] test = new byte[]{0, 1, 2, 3};
+ byte[] test2 = new byte[]{3, 2, 1, 0};
+ Entry entry = db.getDatabase().findEntries("Test attachment").get(0);
+ assertEquals(1, entry.getBinaryPropertyNames().size());
+ entry.setBinaryProperty("test", test);
+ assertArrayEquals(test, entry.getBinaryProperty("test"));
+ entry.setBinaryProperty("test", test2);
+ assertArrayEquals(test2, entry.getBinaryProperty("test"));
+ // true that property was removed
+ assertTrue(entry.removeBinaryProperty("test"));
+ // false that same property was removed
+ assertFalse(entry.removeBinaryProperty("test"));
+ // false that non-existent was removed
+ assertFalse(entry.removeBinaryProperty("test-test"));
+ // same number of properties as we started with
+ assertEquals(1, entry.getBinaryPropertyNames().size());
+ }
+
+ /**
+ * Checks that a database with binary properties saves and reloads correctly
+ */
+ @Test
+ default void saveAndReloadCheck() throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ Path file = Files.createTempFile("test8", "tmp");
+ testBase.saveDatabase(testBase.getDatabase(), testBase.getCredentials(KdbConsts.PASSWORD_BYTES), Files.newOutputStream(file));
+
+ Database db = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), Files.newInputStream(file));
+ Entry newEntry = db.findEntries("Test attachment").get(0);
+ assertArrayEquals(new String[]{"letter J.jpeg"}, newEntry.getBinaryPropertyNames().toArray());
+ Entry oldEntry = testBase.getDatabase().findEntries("Test attachment").get(0);
+ assertArrayEquals(oldEntry.getBinaryProperty("letter J.jpeg"), newEntry.getBinaryProperty("letter J.jpeg"));
+
+ newEntry = db.findEntries("Test 2 attachment").get(0);
+ assertArrayEquals(new String[]{"letter J.jpeg", "letter L.jpeg"}, newEntry.getBinaryPropertyNames().toArray());
+ oldEntry = testBase.getDatabase().findEntries("Test 2 attachment").get(0);
+ assertArrayEquals(oldEntry.getBinaryProperty("letter J.jpeg"), newEntry.getBinaryProperty("letter J.jpeg"));
+ assertArrayEquals(oldEntry.getBinaryProperty("letter L.jpeg"), newEntry.getBinaryProperty("letter L.jpeg"));
+
+ }
+
+ /**
+ * Checks that a new database can add binary properties saves and reloads correctly
+ */
+ @Test
+ default void createAndSaveCheck() throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ Path file = Files.createTempFile("keepass", "tmp");
+ Database database1 = testBase.createDatabase();
+ Entry entry = database1.newEntry("Test attachment");
+ database1.getRootGroup().addEntry(entry);
+ InputStream testFile = getClass().getClassLoader().getResourceAsStream("letter J.jpeg");
+ assert testFile != null;
+ byte[] letterJ = IOUtils.toByteArray(testFile);
+ entry.setBinaryProperty("letter J.jpeg", letterJ);
+ testBase.saveDatabase(database1, testBase.getCredentials(KdbConsts.PASSWORD_BYTES), Files.newOutputStream(file));
+
+ Database db = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), Files.newInputStream(file));
+ Entry entry1 = db.findEntries("Test attachment").get(0);
+ // just one property
+ assertArrayEquals(new String[]{"letter J.jpeg"}, entry1.getBinaryPropertyNames().toArray());
+ // content is correct
+ assertArrayEquals(letterJ, entry1.getBinaryProperty("letter J.jpeg"));
+ }
+}
diff --git a/database/src/test/java/org/linguafranca/pwdb/test/DatabaseTestBase.java b/database/src/test/java/org/linguafranca/pwdb/test/DatabaseTestBase.java
new file mode 100644
index 00000000..b4ffdc9e
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/pwdb/test/DatabaseTestBase.java
@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package org.linguafranca.pwdb.test;
+
+import org.jspecify.annotations.Nullable;
+import org.junit.jupiter.api.BeforeAll;
+import org.linguafranca.pwdb.Credentials;
+import org.linguafranca.pwdb.Database;
+
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Objects;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+import java.util.function.Supplier;
+
+public final class DatabaseTestBase {
+
+ @FunctionalInterface
+ public interface TriConsumer {
+
+ void accept(A a, B b, C c);
+
+ default TriConsumer andThen(TriConsumer after) {
+ Objects.requireNonNull(after);
+
+ return (l, r,c) -> {
+ accept(l, r, c);
+ after.accept(l, r, c);
+ };
+ }
+ }
+
+ public Database database;
+ public final Supplier creator;
+ public final BiFunction loader;
+ public final TriConsumer saver;
+ public final Function credentials;
+
+ public DatabaseTestBase(Supplier creator,
+ BiFunction loader,
+ TriConsumer saver,
+ Function credentials) {
+ this.creator = creator;
+ this.loader = loader;
+ this.saver = saver;
+ this.credentials = credentials;
+ this.database = createDatabase();
+ }
+
+ /**
+ * Create a new database
+ */
+ public Database createDatabase() {
+ return this.creator.get();
+ }
+
+ /**
+ * Get the current default database
+ */
+ public Database getDatabase() {
+ return database;
+ }
+
+ public Database loadDatabase(byte[] credentials, String resourceName) {
+ return loader.apply(getCredentials(credentials), getClass().getClassLoader().getResourceAsStream(resourceName));
+ }
+
+ public Database loadDatabase(Credentials credentials, InputStream inputStream) {
+ return loader.apply(credentials, inputStream);
+ }
+
+ public Database loadAndInitDatabase(byte[] credentials, String resourceName) {
+ this.database = loader.apply(getCredentials(credentials), getClass().getClassLoader().getResourceAsStream(resourceName));
+ return this.database;
+ }
+
+ public Database loadAndInitDatabase(Credentials credentials, InputStream inputStream) {
+ this.database = loadDatabase(credentials, inputStream);
+ return this.database;
+ }
+
+
+ public void saveDatabase(Database database, Credentials credentials, OutputStream outputStream){
+ saver.accept(database, credentials, outputStream);
+ }
+
+ public Credentials getCredentials(byte[] credentials){
+ return this.credentials.apply(credentials);
+ }
+}
diff --git a/test/src/main/java/org/linguafranca/pwdb/checks/BasicDatabaseChecks.java b/database/src/test/java/org/linguafranca/pwdb/test/GroupsAndEntriesTest.java
similarity index 58%
rename from test/src/main/java/org/linguafranca/pwdb/checks/BasicDatabaseChecks.java
rename to database/src/test/java/org/linguafranca/pwdb/test/GroupsAndEntriesTest.java
index dd0d06b5..7adee132 100644
--- a/test/src/main/java/org/linguafranca/pwdb/checks/BasicDatabaseChecks.java
+++ b/database/src/test/java/org/linguafranca/pwdb/test/GroupsAndEntriesTest.java
@@ -1,4 +1,21 @@
/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.test;/*
* Copyright 2015 Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,10 +31,7 @@
* limitations under the License.
*/
-package org.linguafranca.pwdb.checks;
-
-import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
import org.linguafranca.pwdb.Database;
import org.linguafranca.pwdb.Entry;
import org.linguafranca.pwdb.Group;
@@ -28,74 +42,78 @@
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
+import java.util.function.Supplier;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
+import static org.linguafranca.pwdb.Entry.STANDARD_PROPERTY_NAME.PASSWORD;
/**
* @author Jo
*/
-public abstract class BasicDatabaseChecks , G extends Group, E extends Entry, I extends Icon> {
+public interface GroupsAndEntriesTest {
- protected Database database;
-
- public abstract Database createDatabase() throws IOException;
+ Supplier getDbFunc();
+
+ @Test
+ default void testEmptyDatabase() {
+ DatabaseTestBase db = getDbFunc().get();
- public BasicDatabaseChecks() throws IOException {
- this.database = createDatabase();
+ assertEquals("Root", db.getDatabase().getRootGroup().getName());
+ assertEquals(0, db.getDatabase().getRootGroup().getEntries().size());
+ assertEquals(0, db.getDatabase().getRootGroup().getGroups().size());
}
@Test
- public void testEmptyDatabase() {
- assertEquals("Root", database.getRootGroup().getName());
- assertEquals(0, database.getRootGroup().getEntries().size());
- assertEquals(0, database.getRootGroup().getGroups().size());
- }
+ default void testAddGroup() {
+ DatabaseTestBase db = getDbFunc().get();
- @Test
- public void testAddGroup() {
- G g1 = database.getRootGroup().addGroup(database.newGroup("group1"));
- assertEquals(1, database.getRootGroup().getGroups().size());
+ Group g1 = db.getDatabase().getRootGroup().addGroup(db.getDatabase().newGroup("group1"));
+ assertEquals(1, db.getDatabase().getRootGroup().getGroups().size());
assertEquals("group1", g1.getName());
assertEquals(0, g1.getGroups().size());
assertEquals(0, g1.getEntries().size());
- assertEquals("root is not the parent of its child", g1.getParent(), database.getRootGroup());
+ assertEquals(g1.getParent(), db.getDatabase().getRootGroup(), "root is not the parent of its child");
- G g2 = database.newGroup();
+ Group g2 = db.getDatabase().newGroup();
assertEquals("", g2.getName());
- Assert.assertNotNull(g2.getUuid());
+ assertNotNull(g2.getUuid());
assertEquals(0, g2.getIcon().getIndex());
assertEquals(0, g2.getGroups().size());
assertEquals(0, g2.getEntries().size());
// show that the list of groups is a copy
- database.getRootGroup().getGroups().clear();
- assertEquals(1, database.getRootGroup().getGroups().size());
+ db.getDatabase().getRootGroup().getGroups().clear();
+ assertEquals(1, db.getDatabase().getRootGroup().getGroups().size());
assertEquals(0, g1.getEntries().size());
}
@Test
- public void testDeleteGroup () {
- Group g1 = database.getRootGroup().addGroup(database.newGroup("group1"));
- List l1 = database.getRootGroup().findGroups("group1");
+ default void testDeleteGroupDetail () {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Group g1 = db.getDatabase().getRootGroup().addGroup(db.getDatabase().newGroup("group1"));
+ List l1 = db.getDatabase().getRootGroup().findGroups("group1");
assertEquals(1, l1.size());
- G g2 = l1.get(0);
+ Group g2 = l1.get(0);
assertEquals(g2, g1);
- G g3 = database.getRootGroup().removeGroup(g2);
+ Group g3 = db.getDatabase().getRootGroup().removeGroup(g2);
assertEquals(g3, g1);
assertNull(g1.getParent());
- assertEquals(0, database.getRootGroup().getGroups().size());
- assertEquals(0, database.getRootGroup().findGroups("group1").size());
+ assertEquals(0, db.getDatabase().getRootGroup().getGroups().size());
+ assertEquals(0, db.getDatabase().getRootGroup().findGroups("group1").size());
}
@Test
- public void testAddRemoveEntry() {
- E e1 = database.getRootGroup().addEntry(database.newEntry());
+ default void testAddRemoveEntry() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry e1 = db.getDatabase().getRootGroup().addEntry(db.getDatabase().newEntry());
e1.setTitle("entry1");
- List l1 = database.findEntries("entry1");
+ List l1 = db.getDatabase().findEntries("entry1");
assertEquals(1, l1.size());
- E e12 = database.getRootGroup().addEntry(database.newEntry("entry12"));
- List l2 = database.findEntries("entry1");
+ Entry e12 = db.getDatabase().getRootGroup().addEntry(db.getDatabase().newEntry("entry12"));
+ List l2 = db.getDatabase().findEntries("entry1");
assertEquals(2, l2.size());
// show that the entries are different
@@ -103,34 +121,36 @@ public void testAddRemoveEntry() {
// show that the list is a copy
l2.clear();
- assertEquals(2, database.findEntries("entry1").size());
+ assertEquals(2, db.getDatabase().findEntries("entry1").size());
// show that we get an equivalent entry when we remove to when we inserted
- E e12b = database.getRootGroup().removeEntry(e12);
+ Entry e12b = db.getDatabase().getRootGroup().removeEntry(e12);
assertEquals(e12b, e12);
// has been unhooked from parent
assertNull(e12.getParent());
- assertEquals(1, database.findEntries("entry1").size());
+ assertEquals(1, db.getDatabase().findEntries("entry1").size());
}
@Test
- public void testSetFields () {
- E e1 = database.newEntry("Entry 1");
+ default void testSetFields () {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry e1 = db.getDatabase().newEntry("Entry 1");
e1.setNotes("this looks a little like Entry 2");
assertEquals("this looks a little like Entry 2", e1.getNotes());
e1.setUsername("jake@window.com");
assertEquals("jake@window.com", e1.getUsername());
- e1.setPassword("supercalifragelisticexpialidocious");
- assertEquals("supercalifragelisticexpialidocious", e1.getPassword());
+ e1.setProperty(PASSWORD, "supercalifragelisticexpialidocious");
+ assertEquals("supercalifragelisticexpialidocious", e1.getProperty(PASSWORD));
e1.setUrl("https://window.com");
assertEquals("https://window.com", e1.getUrl());
- Assert.assertTrue(e1.match("2"));
- Assert.assertTrue(e1.matchTitle("1"));
- Assert.assertFalse(e1.matchTitle("doggy"));
+ assertTrue(e1.match("2"));
+ assertTrue(e1.matchTitle("1"));
+ assertFalse(e1.matchTitle("doggy"));
- I ic1 = database.newIcon(27);
+ Icon ic1 = db.getDatabase().newIcon(27);
e1.setIcon(ic1);
assertEquals(e1.getIcon(), ic1);
@@ -142,7 +162,7 @@ public void testSetFields () {
e1.setProperty(Entry.STANDARD_PROPERTY_NAME_NOTES, "notes");
assertEquals("notes", e1.getNotes());
e1.setProperty(Entry.STANDARD_PROPERTY_NAME_PASSWORD, "password");
- assertEquals("password", e1.getPassword());
+ assertEquals("password", e1.getProperty(PASSWORD));
e1.setProperty(Entry.STANDARD_PROPERTY_NAME_URL, "url");
assertEquals("url", e1.getUrl());
@@ -153,10 +173,10 @@ public void testSetFields () {
properties.add("silly");
// remove all properties to show that getProperties returns all the values we want
properties.removeAll(e1.getPropertyNames());
- Assert.assertEquals(0, properties.size());
+ assertEquals(0, properties.size());
} catch (UnsupportedOperationException e) {
// databases don't have to support arbitrary properties
- assertFalse(database.supportsNonStandardPropertyNames());
+ assertFalse(db.getDatabase().supportsNonStandardPropertyNames());
assertArrayEquals(e1.getPropertyNames().toArray(), Entry.STANDARD_PROPERTY_NAMES.toArray());
}
@@ -168,9 +188,11 @@ public void testSetFields () {
}
@Test
- public void testTimes() {
+ default void testTimes() {
+ DatabaseTestBase db = getDbFunc().get();
+
long beforeSecond = Instant.now().toEpochMilli()/1000;
- E entry = database.newEntry();
+ Entry entry = db.getDatabase().newEntry();
long afterSecond = Instant.now().toEpochMilli()/1000;
long createdSecond = entry.getCreationTime().getTime()/1000;
@@ -189,17 +211,19 @@ public void testTimes() {
}
@Test
- public void checkAddChangeRemoveProperty() {
+ default void checkAddChangeRemoveProperty() {
+ DatabaseTestBase db = getDbFunc().get();
+
// only applies to databases that support arbitrary properties
- E entry = database.newEntry();
+ Entry entry = db.getDatabase().newEntry();
assertEquals(Entry.STANDARD_PROPERTY_NAMES.size(), entry.getPropertyNames().size());
try {
entry.setProperty("test", "test1");
} catch (UnsupportedOperationException e) {
- if (!database.supportsNonStandardPropertyNames()) {
+ if (!db.getDatabase().supportsNonStandardPropertyNames()) {
return;
}
- fail("Database must report that it doesn't support non standrad properties");
+ fail("Database must report that it doesn't support non standard properties");
}
assertEquals("test1", entry.getProperty("test"));
entry.setProperty("test", "test2");
@@ -218,49 +242,53 @@ public void checkAddChangeRemoveProperty() {
@Test
- public void testNewEntry() {
- E e2 = database.newEntry();
- Assert.assertNull(e2.getParent());
- assertEquals("", e2.getPassword());
- Assert.assertNotNull(e2.getUuid());
+ default void testNewEntryInit() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry e2 = db.getDatabase().newEntry();
+ assertNull(e2.getParent());
+ assertEquals("", e2.getProperty(PASSWORD));
+ assertNotNull(e2.getUuid());
assertEquals("", e2.getUrl());
assertEquals("", e2.getNotes());
assertEquals("", e2.getUsername());
assertEquals("", e2.getTitle());
- Assert.assertNull(e2.getProperty("silly"));
+ assertNull(e2.getProperty("silly"));
List l = e2.getPropertyNames();
l.removeAll(Entry.STANDARD_PROPERTY_NAMES);
- Assert.assertEquals(0, l.size());
+ assertEquals(0, l.size());
}
@Test
- public void testCopy() throws IOException {
- E entry1 = database.newEntry();
+ default void testCopy() throws IOException {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry entry1 = db.getDatabase().newEntry();
entry1.setTitle("Entry");
entry1.setUsername("Username");
- entry1.setPassword("Password");
+ entry1.setProperty(PASSWORD, "Password");
entry1.setUrl("https://dont.follow.me");
entry1.setNotes("Notes");
- entry1.setIcon(database.newIcon(2));
+ entry1.setIcon(db.getDatabase().newIcon(2));
// create a new Database
- Database database2 = createDatabase();
+ Database database2 = db.createDatabase();
// create a new Entry in new Database
- E entry2 = database2.newEntry(entry1);
+ Entry entry2 = database2.newEntry(entry1);
assertEquals(entry1.getTitle(), entry2.getTitle());
assertEquals(entry1.getUsername(), entry2.getUsername());
- assertEquals(entry1.getPassword(), entry2.getPassword());
+ assertEquals(entry1.getProperty(PASSWORD), entry2.getProperty(PASSWORD));
assertEquals(entry1.getUrl(), entry2.getUrl());
assertEquals(entry1.getNotes(), entry2.getNotes());
assertEquals(entry1.getIcon(), entry2.getIcon());
assertNotEquals(entry1.getUuid(), entry2.getUuid());
- G group1 = database.newGroup();
+ Group group1 = db.getDatabase().newGroup();
group1.setName("Group");
- group1.setIcon(database.newIcon(3));
+ group1.setIcon(db.getDatabase().newIcon(3));
- G group2 = database2.newGroup(group1);
+ Group group2 = database2.newGroup(group1);
assertEquals(group1.getName(), group2.getName());
assertEquals(group1.getIcon(), group2.getIcon());
assertNotEquals(group1.getUuid(), group2.getUuid());
diff --git a/test/src/main/java/org/linguafranca/pwdb/checks/SaveAndReloadChecks.java b/database/src/test/java/org/linguafranca/pwdb/test/KdbxFileSaveAndReloadTest.java
similarity index 51%
rename from test/src/main/java/org/linguafranca/pwdb/checks/SaveAndReloadChecks.java
rename to database/src/test/java/org/linguafranca/pwdb/test/KdbxFileSaveAndReloadTest.java
index 82c4733f..472f4b88 100644
--- a/test/src/main/java/org/linguafranca/pwdb/checks/SaveAndReloadChecks.java
+++ b/database/src/test/java/org/linguafranca/pwdb/test/KdbxFileSaveAndReloadTest.java
@@ -1,110 +1,119 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
+ * Copyright (c) 2026. Sergio Lissner
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
-package org.linguafranca.pwdb.checks;
+package org.linguafranca.pwdb.test;
-import org.junit.Assert;
-import org.junit.BeforeClass;
-import org.junit.Ignore;
-import org.junit.Test;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
import org.linguafranca.pwdb.*;
import java.io.*;
import java.nio.file.Files;
+import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.UUID;
+import java.util.function.Supplier;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
+import static org.linguafranca.pwdb.Entry.STANDARD_PROPERTY_NAME.*;
import static org.linguafranca.util.TestUtil.getTestPrintStream;
+
/**
* @author jo
+ * @author Sergio Lissner
*/
-public abstract class SaveAndReloadChecks , G extends Group, E extends Entry, I extends Icon>{
-
- static PrintStream printStream = getTestPrintStream();
+public interface KdbxFileSaveAndReloadTest {
- public abstract D getDatabase();
- public abstract D getDatabase(String name, Credentials credentials) throws IOException;
+ Supplier getDbFunc();
- public abstract void saveDatabase(D database, Credentials credentials, OutputStream outputStream) throws IOException;
- public abstract D loadDatabase(Credentials credentials, InputStream inputStream) throws IOException;
- public abstract Credentials getCreds(byte[] creds);
- public abstract boolean verifyStreamFormat (StreamFormat s1, StreamFormat s2);
-
- @BeforeClass
- public static void ensureOutputDir() throws IOException {
- Files.createDirectories(Paths.get("testOutput"));
- }
+ boolean verifyStreamFormat(StreamFormat s1, StreamFormat s2);
/**
* Test verifies that entries contain the same content on reload as they did on save,
* and also verifies that saving doesn't alter the contents
*/
@Test
- public void saveAndReloadTest() throws IOException {
+ default void saveAndReloadTest(@TempDir Path tempPath) throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
long now = System.currentTimeMillis();
// create database with known content
- D output = createNewDatabase();
+ Database output = createNewDatabase();
verifyContents(output);
//output.save(new StreamFormat.None(), new Credentials.None(), printStream);
- FileOutputStream fos = new FileOutputStream("testOutput/test1.kdbx");
- saveDatabase(output, getCreds("123".getBytes()), fos);
- Assert.assertFalse(output.isDirty());
- fos.flush();
- fos.close();
+ Path dbPath = tempPath.resolve("test1.kdbx");
+ try (OutputStream fos = Files.newOutputStream(dbPath)) {
+ testBase.saveDatabase(output, testBase.getCredentials(KdbConsts.PASSWORD_BYTES), fos);
+ assertFalse(output.isDirty());
+ fos.flush();
+ fos.close();
+ }
// make sure that saving didn't mess up content
verifyContents(output);
//output.save(new StreamFormat.None(), new Credentials.None(), printStream);
-
- FileInputStream fis = new FileInputStream("testOutput/test1.kdbx");
- D input = loadDatabase(getCreds("123".getBytes()), fis);
+ Database input;
+ try (InputStream fis = Files.newInputStream(dbPath)) {
+ input = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), fis);
+ }
verifyContents(input);
- //input.save(new StreamFormat.None(), new Credentials.None(), printStream);
- printStream.format("Test took %d millis", System.currentTimeMillis() - now);
}
/**
* Test verifies that attachments are saved and reloaded correctly
*/
@Test
- public void saveAndReloadTest2() throws IOException {
- D attachment = getDatabase("Attachment.kdbx", getCreds("123".getBytes()));
+ default void saveAndReloadTest2(@TempDir Path tempDir) throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ Database attachment;
+ try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream("Attachment.kdbx")) {
+ assertNotNull(inputStream);
+ attachment = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES),
+ inputStream);
+ }
- E entry = attachment.findEntries("Test attachment").get(0);
+ Entry entry = attachment.findEntries("Test attachment").get(0);
assertArrayEquals(new String[] {"letter J.jpeg"}, entry.getBinaryPropertyNames().toArray());
- E entry2 = attachment.findEntries("Test 2 attachment").get(0);
+ Entry entry2 = attachment.findEntries("Test 2 attachment").get(0);
assertArrayEquals(new String[] {"letter J.jpeg", "letter L.jpeg"}, entry2.getBinaryPropertyNames().toArray());
byte[] content = entry2.getBinaryProperty("letter L.jpeg");
+ assertNotNull(content);
entry.setBinaryProperty("letter L.jpeg", content);
assertArrayEquals(new String[] {"letter J.jpeg", "letter L.jpeg"}, entry.getBinaryPropertyNames().toArray());
- FileOutputStream fos = new FileOutputStream("testOutput/test2.kdbx");
- saveDatabase(attachment, getCreds("123".getBytes()), fos);
- fos.flush();
- fos.close();
+ Path dbPath = tempDir.resolve("test2.kdbx");
+ try (OutputStream fos = Files.newOutputStream(dbPath)) {
+ testBase.saveDatabase(attachment, testBase.getCredentials(KdbConsts.PASSWORD_BYTES), fos);
+ fos.flush();
+ fos.close();
+ }
- FileInputStream fis = new FileInputStream("testOutput/test2.kdbx");
- D input = loadDatabase(getCreds("123".getBytes()), fis);
+ Database input;
+ try (InputStream fis = Files.newInputStream(dbPath)) {
+ input = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), fis);
+ }
entry = input.findEntries("Test attachment").get(0);
assertArrayEquals(new String[] {"letter J.jpeg", "letter L.jpeg"}, entry.getBinaryPropertyNames().toArray());
@@ -112,7 +121,7 @@ public void saveAndReloadTest2() throws IOException {
//saveDatabase(input, new StreamFormat.None(), new Credentials.None(), printStream);
}
- String [] testFiles = {"V4-AES-AES.kdbx",
+ static String [] testFiles = {"V4-AES-AES.kdbx",
"V4-AES-Argon2.kdbx",
"V4-ChaCha20-AES.kdbx",
"V4-ChaCha20-Argon2-Attachment.kdbx"};
@@ -121,25 +130,38 @@ public void saveAndReloadTest2() throws IOException {
* Test verifies that database is saved with same encryption that it was loaded with
*/
@Test
- public void saveAndReloadTest3() throws IOException {
+ default void saveAndReloadTest3(@TempDir Path tempPath) throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
for (String resource: testFiles) {
- D database = getDatabase(resource, this.getCreds("123".getBytes()));
+ Database database;
+ try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(resource)) {
+ assertNotNull(inputStream);
+ database = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), inputStream);
+ }
StreamFormat format1 = database.getStreamFormat();
- database.save(getCreds("123".getBytes()), Files.newOutputStream(Paths.get("testOutput/test3.kdbx")));
+ Path dbPath = tempPath.resolve("test3.kdbx");
+ try (OutputStream outputStream = Files.newOutputStream(dbPath)) {
+ database.save(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), outputStream);
+ }
- FileInputStream fis = new FileInputStream("testOutput/test3.kdbx");
- D input = loadDatabase(getCreds("123".getBytes()), fis);
+ Database input;
+ try (InputStream fis = Files.newInputStream(dbPath)) {
+ input = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), fis);
+ }
StreamFormat format2 = input.getStreamFormat();
assertTrue(verifyStreamFormat(format1, format2));
}
}
- private D createNewDatabase() throws IOException {
- D database = getDatabase();
+ private Database createNewDatabase() throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ Database database = testBase.createDatabase();
for (@SuppressWarnings("WrapperTypeMayBePrimitive") Integer g = 0; g < 5; g++){
- G group = database.getRootGroup().addGroup(database.newGroup(g.toString()));
+ Group group = database.getRootGroup().addGroup(database.newGroup(g.toString()));
for (int e = 0; e <= g; e++) {
group.addEntry(entryFactory(database, g.toString(), e));
}
@@ -148,28 +170,28 @@ private D createNewDatabase() throws IOException {
return database;
}
- private E entryFactory(D database, String g, int e) {
- E result = database.newEntry();
- result.setTitle(g + "-" + e);
- result.setUsername(g + " - un - " + e);
- result.setPassword(g + "- p -" + e);
- result.setUrl(g + "- url - " + e);
- result.setNotes(g + "- n - " + e);
+ private static Entry entryFactory(Database database, String g, int e) {
+ Entry result = database.newEntry();
+ result.addProperty(TITLE, g + "-" + e)
+ .addProperty(USER_NAME, g + " - un - " + e)
+ .addProperty(PASSWORD, g + "- p -" + e)
+ .addProperty(URL,g + "- url - " + e)
+ .addProperty(NOTES,g + "- n - " + e);
return result;
}
- private void verifyContents(D database) {
+ private static void verifyContents(Database database) {
for (Integer g = 0; g< 5; g++){
- G group = database.getRootGroup().getGroups().get(g);
+ Group group = database.getRootGroup().getGroups().get(g);
assertEquals(g.toString(), group.getName());
assertEquals(g + 1, group.getEntries().size());
assertEquals(g+1, group.getEntriesCount());
assertEquals(database.getRootGroup(), group.getParent());
for (int e = 0; e <= g; e++) {
- E entry = group.getEntries().get(e);
+ Entry entry = group.getEntries().get(e);
assertEquals(g + "-" + e, entry.getTitle());
assertEquals(g + " - un - " + e, entry.getUsername());
- assertEquals(g + "- p -" + e, entry.getPassword());
+ assertEquals(g + "- p -" + e, entry.getProperty(PASSWORD));
assertEquals(g + "- url - " + e, entry.getUrl());
assertEquals(g + "- n - " + e, entry.getNotes());
assertEquals(group, entry.getParent());
@@ -182,38 +204,44 @@ private void verifyContents(D database) {
*
* @throws IOException when naughty
*/
- @Test @Ignore
- public void saveNewDatabase () throws IOException {
- D database = createNewDatabase();
+ @Disabled
+ default void saveNewDatabase(@TempDir Path tempPath) throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ Database database = createNewDatabase();
- FileOutputStream outputStream = new FileOutputStream("compatibility.kdbx");
- saveDatabase(database, getCreds("123".getBytes()), outputStream);
+ Path dbPath = tempPath.resolve("compatibility.kdbx");
+ try (OutputStream outputStream = Files.newOutputStream(dbPath)) {
+ testBase.saveDatabase(database, testBase.getCredentials(KdbConsts.PASSWORD_BYTES), outputStream);
+ }
}
/**
* Doesn't do anything other than output the database using default PrintVisitor
* @throws IOException when naughty
*/
- @Test @Ignore
- public void inspectNewDatabase () throws IOException {
- D database = createNewDatabase();
+ @Disabled
+ default void inspectNewDatabase () throws IOException {
+ Database database = createNewDatabase();
- database.visit(new Visitor.Print(printStream));
+ database.visit(new Visitor.Print(getTestPrintStream()));
}
// create a new database for messing around with
- // the assertions here somewhat duplicate those in BasicDatabaseChecks
+ // the assertions here somewhat duplicate those elsewhere
@Test
- public void testNewDatabase() throws IOException {
- D database = getDatabase();
- G root = database.getRootGroup();
- Assert.assertTrue(root.isRootGroup());
+ default void testNewDatabase() throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ Database database = testBase.createDatabase();
+ Group root = database.getRootGroup();
+ assertTrue(root.isRootGroup());
assertEquals(0, root.getGroups().size());
assertEquals(0, root.getEntries().size());
- Assert.assertTrue(database.shouldProtect("Password"));
- Assert.assertFalse(database.shouldProtect("Title"));
- Assert.assertFalse(database.shouldProtect("Bogus"));
+ assertTrue(database.shouldProtect("Password"));
+ assertFalse(database.shouldProtect("Title"));
+ assertFalse(database.shouldProtect("Bogus"));
assertEquals("New Database", database.getName());
database.setName("Modified Database");
@@ -223,13 +251,13 @@ public void testNewDatabase() throws IOException {
database.setDescription("Test Database");
assertEquals("Test Database", database.getDescription());
- G group1 = database.newGroup("Group 1");
+ Group group1 = database.newGroup("Group 1");
UUID newGroupUUID = group1.getUuid();
root.addGroup(group1);
assertEquals("Group 1", group1.getName());
- Assert.assertFalse(group1.isRootGroup());
- Assert.assertTrue(root.isRootGroup());
+ assertFalse(group1.isRootGroup());
+ assertTrue(root.isRootGroup());
assertEquals(1, root.getGroups().size());
assertEquals(newGroupUUID, root.getGroups().get(0).getUuid());
@@ -246,11 +274,11 @@ public void testNewDatabase() throws IOException {
try {
root.setParent(group1);
- Assert.fail("Cannot add root group to another group");
+ fail("Cannot add root group to another group");
} catch (Exception ignored) {
}
- G group2 = database.newGroup();
+ Group group2 = database.newGroup();
group2.setName("Group 2");
group1.addGroup(group2);
assertEquals(1, group1.getGroups().size());
@@ -260,7 +288,7 @@ public void testNewDatabase() throws IOException {
assertEquals(0, group1.getGroups().size());
assertEquals(2, root.getGroups().size());
- E entry1 = database.newEntry();
+ Entry entry1 = database.newEntry();
entry1.setTitle("A new entry");
assertEquals("A new entry", entry1.getTitle());
entry1.setUsername("user name");
@@ -274,12 +302,12 @@ public void testNewDatabase() throws IOException {
group2.addEntry(entry1);
assertEquals(1, group2.getEntries().size());
- entry1.setPassword("pass");
- assertEquals("pass", entry1.getPassword());
+ entry1.addProperty(PASSWORD, "pass");
+ assertEquals("pass", entry1.getProperty(PASSWORD));
- E entry2 = database.newEntry(entry1);
- entry2.setPassword("pass2");
- assertEquals("pass2", entry2.getPassword());
+ Entry entry2 = database.newEntry(entry1);
+ entry2.addProperty(PASSWORD,"pass2");
+ assertEquals("pass2", entry2.getProperty(PASSWORD));
group2.addEntry(entry2);
assertEquals(2, group2.getEntries().size());
diff --git a/database/src/test/java/org/linguafranca/pwdb/test/ProtectedPropertyTest.java b/database/src/test/java/org/linguafranca/pwdb/test/ProtectedPropertyTest.java
new file mode 100644
index 00000000..7e7ae22f
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/pwdb/test/ProtectedPropertyTest.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.test;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.linguafranca.pwdb.*;
+
+import java.util.List;
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.linguafranca.pwdb.Entry.STANDARD_PROPERTY_NAME.PASSWORD;
+import static org.linguafranca.pwdb.Entry.STANDARD_PROPERTY_NAME.USER_NAME;
+
+public interface ProtectedPropertyTest {
+
+ Supplier getDbFunc();
+
+ @Test
+ default void testShouldProtect() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ String propertyName = PASSWORD;
+ assertThrows(UnsupportedOperationException.class,
+ () -> testBase.getDatabase().setShouldProtect(propertyName, false),
+ "By default the ProtectionStrategy should be immutable");
+ assertTrue(testBase.getDatabase().shouldProtect(propertyName));
+ }
+
+ @Test
+ default void testSetShouldProtect() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ testBase.getDatabase().setPropertyValueStrategy(new PropertyValue.Strategy.MutableProtectionStrategy());
+ String propertyName = PASSWORD;
+ testBase.getDatabase().setShouldProtect(propertyName, true);
+ assertTrue(testBase.getDatabase().shouldProtect(propertyName));
+
+ testBase.getDatabase().setShouldProtect(propertyName, false);
+ assertFalse(testBase.getDatabase().shouldProtect(propertyName));
+ }
+
+ @Test
+ default void testListShouldProtect() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ testBase.getDatabase().setPropertyValueStrategy(new PropertyValue.Strategy.MutableProtectionStrategy());
+ String propertyName1 = PASSWORD;
+ String propertyName2 = USER_NAME;
+ testBase.getDatabase().setShouldProtect(propertyName1, true);
+ testBase.getDatabase().setShouldProtect(propertyName2, true);
+
+ List protectedProperties = testBase.getDatabase().listShouldProtect();
+ assertTrue(protectedProperties.contains(propertyName1));
+ assertTrue(protectedProperties.contains(propertyName2));
+ }
+
+ @Test
+ default void testGetPropertyValueStrategy() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ PropertyValue.Strategy strategy = testBase.getDatabase().getPropertyValueStrategy();
+ assertNotNull(strategy);
+ }
+
+ @Test
+ default void testSetPropertyValueStrategy() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ PropertyValue.Strategy newStrategy = new PropertyValue.Strategy.Default();
+ testBase.getDatabase().setPropertyValueStrategy(newStrategy);
+ assertEquals(newStrategy, testBase.getDatabase().getPropertyValueStrategy());
+ }
+
+ @Test
+ default void testSupportsPropertyValueStrategy() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ assertTrue(testBase.getDatabase().supportsPropertyValueStrategy());
+ }
+}
\ No newline at end of file
diff --git a/database/src/test/java/org/linguafranca/pwdb/test/ProtectedPropertyTest2.java b/database/src/test/java/org/linguafranca/pwdb/test/ProtectedPropertyTest2.java
new file mode 100644
index 00000000..d0799918
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/pwdb/test/ProtectedPropertyTest2.java
@@ -0,0 +1,172 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.test;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.linguafranca.pwdb.Database;
+import org.linguafranca.pwdb.Entry;
+import org.linguafranca.pwdb.KdbConsts;
+import org.linguafranca.pwdb.PropertyValue;
+
+import java.io.*;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public interface ProtectedPropertyTest2 {
+
+ Supplier getDbFunc();
+
+ /*
+ void newDatabase();
+
+ Database testBase.getDatabase();
+
+ void saveDatabase(Database database, Credentials credentials, OutputStream outputStream) throws IOException;
+
+ Database loadDatabase(Credentials credentials, InputStream inputStream) throws IOException;
+
+ Credentials getCredentials(byte[] credentials);
+
+ @BeforeEach
+ default void ppt2SetUp() throws Exception {
+ newDatabase();
+ }
+
+*/
+ /**
+ * Catches expected thrown exception
+ *
+ * @param f a Consumer i.e. a function that does have output
+ * @param c the exception that is expected to be thrown when the function is executed
+ */
+ private static void catchException(Consumer f, @SuppressWarnings("SameParameterValue") Class c) {
+ try {
+ f.accept(null);
+ }
+ catch (Exception e) {
+ if (c.equals(e.getClass())) {
+ return;
+ }
+ }
+ fail(c.getName() + " expected");
+ }
+
+ /**
+ * Check that unsupported operations throw exceptions
+ */
+ @Test
+ default void noPropertyValueSupport() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ if (testBase.getDatabase().supportsPropertyValueStrategy()) {
+ return;
+ }
+
+ assertFalse(testBase.getDatabase().supportsPropertyValueStrategy());
+ // test a sample of the methods that are supposed to thrown if used here
+ catchException((_) -> testBase.getDatabase().setPropertyValueStrategy(null), UnsupportedOperationException.class);
+ catchException((_) -> testBase.getDatabase().getPropertyValueStrategy(), UnsupportedOperationException.class);
+ catchException((_) -> testBase.getDatabase().setShouldProtect(null, true), UnsupportedOperationException.class);
+ catchException((_) -> testBase.getDatabase().listShouldProtect(), UnsupportedOperationException.class);
+
+ Entry entry = testBase.getDatabase().newEntry();
+ catchException((z) -> entry.getPropertyValue(null), UnsupportedOperationException.class);
+ catchException((z) -> entry.setPropertyValue(null, (PropertyValue) null), UnsupportedOperationException.class);
+
+ }
+
+ @Test
+ default void checkDefaults() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ // these are the defaults established by createDatabase()
+ assertTrue(testBase.getDatabase().shouldProtect(Entry.STANDARD_PROPERTY_NAME_PASSWORD));
+ assertFalse(testBase.getDatabase().shouldProtect(Entry.STANDARD_PROPERTY_NAME_USER_NAME));
+ assertFalse(testBase.getDatabase().shouldProtect(Entry.STANDARD_PROPERTY_NAME_NOTES));
+ assertFalse(testBase.getDatabase().shouldProtect(Entry.STANDARD_PROPERTY_NAME_URL));
+ assertFalse(testBase.getDatabase().shouldProtect(Entry.STANDARD_PROPERTY_NAME_TITLE));
+ }
+
+ @Test
+ default void expectedStorageType(@TempDir Path tempPath) throws IOException {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ if (!testBase.getDatabase().supportsPropertyValueStrategy()) {
+ return;
+ }
+
+ // Password is protected
+ PropertyValue.Strategy pvs = testBase.getDatabase().getPropertyValueStrategy();
+ PropertyValue pv = pvs.getFactoryFor("Password").of("123");
+ assertEquals(pv.getClass(), pvs.newProtected().of("a").getClass());
+ assertTrue(pv.isProtected());
+
+ // Notes isn't protected
+ pv = pvs.getFactoryFor("Notes").of("123");
+ assertEquals(pv.getClass(), pvs.newUnprotected().of("b").getClass());
+ assertFalse(pv.isProtected());
+
+ // "random" is not protected
+ pv = pvs.getFactoryFor("random").of("123");
+ assertEquals(pv.getClass(), pvs.newUnprotected().of("b").getClass());
+ assertFalse(pv.isProtected());
+
+ // create a strategy that makes "random" protected
+ PropertyValue.Strategy newPvs = new PropertyValue.Strategy.MutableProtectionStrategy();
+ testBase.getDatabase().setPropertyValueStrategy(newPvs);
+ testBase.getDatabase().setShouldProtect("random", true);
+
+ // get a value for random and check it is protected
+ pv = newPvs.getFactoryFor("random").of("123");
+ assertEquals(pv.getClass(), pvs.newProtected().of("b").getClass());
+ assertTrue(pv.isProtected());
+
+ // create an entry with random property as protected value
+ Entry entry = testBase.getDatabase().newEntry("Test Random");
+ entry.setPropertyValue("random", pv);
+ testBase.getDatabase().getRootGroup().addEntry(entry);
+
+ // Save database
+
+ Path dbPath = tempPath.resolve("test9.kdbx");
+ try (OutputStream fos = Files.newOutputStream(dbPath)) {
+ testBase.saveDatabase(testBase.getDatabase(), testBase.getCredentials(KdbConsts.PASSWORD_BYTES), fos);
+ fos.flush();
+ fos.close();
+ }
+
+ // reload database, "random" is still protected even though it's not protected by default
+ Database input;
+ try (InputStream fis = Files.newInputStream(dbPath)) {
+ input = testBase.loadDatabase(testBase.getCredentials(KdbConsts.PASSWORD_BYTES), fis);
+ }
+
+ List entries = input.findEntries("random");
+ assertEquals(1, entries.size());
+ assertTrue(entries.get(0).getPropertyValue("random").isProtected());
+ assertFalse(input.getPropertyValueStrategy().getProtectedProperties().contains("random"));
+ }
+
+}
+
diff --git a/test/src/main/java/org/linguafranca/pwdb/checks/RecycleBinChecks.java b/database/src/test/java/org/linguafranca/pwdb/test/RecycleBinTest.java
similarity index 58%
rename from test/src/main/java/org/linguafranca/pwdb/checks/RecycleBinChecks.java
rename to database/src/test/java/org/linguafranca/pwdb/test/RecycleBinTest.java
index 3fb007ae..3ca4731b 100644
--- a/test/src/main/java/org/linguafranca/pwdb/checks/RecycleBinChecks.java
+++ b/database/src/test/java/org/linguafranca/pwdb/test/RecycleBinTest.java
@@ -1,31 +1,55 @@
-package org.linguafranca.pwdb.checks;
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.test;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
import org.linguafranca.pwdb.Database;
import org.linguafranca.pwdb.Entry;
import org.linguafranca.pwdb.Group;
-import org.linguafranca.pwdb.Icon;
-import static org.junit.Assert.*;
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
/**
* @author jo
*/
-public abstract class RecycleBinChecks , G extends Group, E extends Entry, I extends Icon> {
+public interface RecycleBinTest {
- protected Database database;
+ Supplier getDbFunc();
@Test
- public void recycleBinEntries() {
+ default void recycleBinEntries() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ assumeTrue(testBase.getDatabase().supportsRecycleBin(), "Database does not support recycle bin, skipping test");
+ Database database = testBase.getDatabase();
database.enableRecycleBin(false);
assertFalse(database.isRecycleBinEnabled());
assertNull(database.getRecycleBin());
database.enableRecycleBin(true);
assertTrue(database.isRecycleBinEnabled());
- G recycleBin = database.getRecycleBin();
+ Group recycleBin = database.getRecycleBin();
assertNotNull(recycleBin);
- E entry = database.newEntry();
+ Entry entry = database.newEntry();
assertEquals(entry, database.getRootGroup().addEntry(entry));
assertEquals(1, database.getRootGroup().getEntriesCount());
@@ -48,13 +72,17 @@ public void recycleBinEntries() {
}
@Test
- public void recycleBinGroups() {
+ default void recycleBinGroups() {
+ DatabaseTestBase testBase = getDbFunc().get();
+
+ assumeTrue(testBase.getDatabase().supportsRecycleBin(), "Database does not support recycle bin, skipping test");
+ Database database = testBase.getDatabase();
database.enableRecycleBin(true);
assertTrue(database.isRecycleBinEnabled());
- G recycleBin = database.getRecycleBin();
+ Group recycleBin = database.getRecycleBin();
assertNotNull(recycleBin);
- G group= database.newGroup();
+ Group group= database.newGroup();
assertEquals(group, database.getRootGroup().addGroup(group));
assertEquals(2, database.getRootGroup().getGroupsCount());
diff --git a/database/src/test/java/org/linguafranca/pwdb/test/Test123Test.java b/database/src/test/java/org/linguafranca/pwdb/test/Test123Test.java
new file mode 100644
index 00000000..364fe495
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/pwdb/test/Test123Test.java
@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.test;
+
+import org.junit.jupiter.api.Test;
+import org.linguafranca.pwdb.*;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.List;
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.linguafranca.pwdb.Entry.STANDARD_PROPERTY_NAME.PASSWORD;
+import static org.linguafranca.util.TestUtil.getTestPrintStream;
+
+/**
+ * a test123 file for each format. Should contain the same thing. This is a basic sanity check.
+ *
+ * (i.e. there exist files called test123 for some formats and this test tests their contents. presumably
+ * back in the day, a database was created then saved in kdbx and kdb formats and when there was more than
+ * one KDBX implementation the test was created to test them all as well as the KDB implementation)
+ */
+public interface Test123Test {
+
+ Supplier getDbFunc();
+
+ boolean getSkipDateCheck();
+ String getFileName();
+
+ SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'hh:mm:ssX");
+
+ @Test
+ default void test123File() throws ParseException, IOException {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Database database;
+ try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(getFileName())) {
+ assertNotNull(inputStream);
+ database = db.loadDatabase(db.getCredentials(KdbConsts.PASSWORD_BYTES), inputStream);
+ }
+ // visit all groups and entries and list them to console
+ database.visit(new Visitor.Print(getTestPrintStream()));
+
+ // find all entries in the database
+ // the kdb version has three additional system related entries
+ List anything = database.findEntries("");
+ assertTrue(10 <= anything.size());
+
+ // find all entries in the database that have the string "test" in them
+ List tests = database.findEntries("test");
+ for (Entry tes: tests) {
+ getTestPrintStream().println(tes.getTitle());
+ }
+ assertEquals(4, tests.size());
+ if (!tests.isEmpty()) {
+ // copy the password of the first entry
+ String pass = tests.get(0).getProperty(PASSWORD);
+ // all the relevant entries should have the password 123
+ String pass2 = tests.get(0).getProperty(PASSWORD);
+ assertEquals(pass, pass2);
+ assertEquals("123", pass2);
+ }
+
+ List passwords = database.findEntries("password");
+ assertEquals(4, passwords.size());
+ for (Entry passwordEntry : passwords) {
+ assertEquals(passwordEntry.getTitle(), passwordEntry.getProperty(PASSWORD));
+ getTestPrintStream().println(passwordEntry.getTitle());
+ }
+
+ List entries = database.findEntries(entry -> entry.getTitle().equals("hello world"));
+
+ assertEquals(1, entries.size());
+ assertEquals("pass", entries.get(0).getProperty(PASSWORD));
+
+ // kdb files don't have a time zone so can't make head or tail of the date - test file seems to have a local time in it
+ if (getSkipDateCheck()) {
+ return;
+ }
+
+ Date c = entries.get(0).getCreationTime();
+ Date expected = sdf.parse("2015-10-24T17:20:41Z");
+ assertEquals(expected, c);
+ }
+}
diff --git a/database/src/test/java/org/linguafranca/pwdb/test/TrivialDatabaseTest.java b/database/src/test/java/org/linguafranca/pwdb/test/TrivialDatabaseTest.java
new file mode 100644
index 00000000..88caea66
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/pwdb/test/TrivialDatabaseTest.java
@@ -0,0 +1,165 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.test;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+import org.linguafranca.pwdb.Database;
+import org.linguafranca.pwdb.Entry;
+import org.linguafranca.pwdb.Group;
+import org.linguafranca.pwdb.Icon;
+
+import java.util.UUID;
+import java.util.function.Supplier;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public interface TrivialDatabaseTest {
+
+ Supplier getDbFunc();
+
+ @Test
+ default void testGetRootGroup() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Group root = db.getDatabase().getRootGroup();
+ assertNotNull(root);
+ assertEquals("Root", root.getName());
+ }
+
+ @Test
+ default void testNewGroup() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Group group = db.getDatabase().newGroup();
+ assertNotNull(group);
+ }
+
+ @Test
+ default void testNewEntry() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry entry = db.getDatabase().newEntry();
+ assertNotNull(entry);
+ }
+
+ @Test
+ default void testNewIcon() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Icon icon = db.getDatabase().newIcon();
+ assertNotNull(icon);
+ }
+
+ @Test
+ default void testNewIconWithInteger() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Icon icon = db.getDatabase().newIcon(1);
+ assertNotNull(icon);
+ assertEquals(1, icon.getIndex());
+ }
+
+ @Test
+ default void testRecycleBin() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ if (db.getDatabase().supportsRecycleBin()) {
+ assertTrue(db.getDatabase().isRecycleBinEnabled());
+ Group recycleBin = db.getDatabase().getRecycleBin();
+ assertNotNull(recycleBin);
+ } else {
+ assertFalse(db.getDatabase().isRecycleBinEnabled());
+ assertThrows(UnsupportedOperationException.class, () -> db.getDatabase().enableRecycleBin(true));
+ assertNull(db.getDatabase().getRecycleBin());
+ }
+ }
+
+ @Test
+ default void testGetSetName() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ assertEquals("New Database", db.getDatabase().getName());
+ db.getDatabase().setName("Test Database");
+ assertEquals("Test Database", db.getDatabase().getName());
+ }
+
+ @Test
+ default void testGetSetDescription() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ assertNotNull(db.getDatabase().getDescription());
+ db.getDatabase().setDescription("Test Description");
+ assertEquals("Test Description", db.getDatabase().getDescription());
+ }
+
+ @Test
+ default void testDeleteEntry() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Entry entry = db.getDatabase().newEntry();
+ db.getDatabase().getRootGroup().addEntry(entry);
+ UUID uuid = entry.getUuid();
+ assertTrue(db.getDatabase().deleteEntry(uuid));
+ assertNull(db.getDatabase().findEntry(uuid));
+ }
+
+ @Test
+ default void testDeleteGroup() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ Group group = db.getDatabase().newGroup();
+ db.getDatabase().getRootGroup().addGroup(group);
+ UUID uuid = group.getUuid();
+ assertTrue(db.getDatabase().deleteGroup(uuid));
+ assertNull(db.getDatabase().findGroup(uuid));
+ }
+
+ @Test
+ default void testSupportsNonStandardPropertyNames() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ // check standard names are there
+ Entry entry = db.getDatabase().newEntry();
+ for (String name : Entry.STANDARD_PROPERTY_NAMES) {
+ assertNotNull(entry.getProperty(name));
+ }
+ // add a random property
+ if (db.getDatabase().supportsNonStandardPropertyNames()) {
+ entry.setProperty("random", "you never know");
+ assertEquals("you never know", entry.getProperty("random"));
+ } else {
+ assertThrows(UnsupportedOperationException.class, () -> entry.setProperty("random", "you never know"));
+ }
+ }
+
+ @Test
+ default void testSupportsBinaryProperties() {
+ DatabaseTestBase db = getDbFunc().get();
+
+ if (db.getDatabase().supportsBinaryProperties()) {
+ Entry entry = db.getDatabase().newEntry();
+ entry.setBinaryProperty("binary", new byte[]{1, 2, 3});
+ assertArrayEquals(new byte[]{1, 2, 3}, entry.getBinaryProperty("binary"));
+ } else {
+ Entry entry = db.getDatabase().newEntry();
+ assertThrows(UnsupportedOperationException.class, () -> entry.setBinaryProperty("binary", new byte[]{1, 2, 3}));
+ }
+ }
+}
\ No newline at end of file
diff --git a/database/src/test/java/org/linguafranca/util/ExecutionListener.java b/database/src/test/java/org/linguafranca/util/ExecutionListener.java
new file mode 100644
index 00000000..1c798048
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/util/ExecutionListener.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.util;
+
+import org.junit.platform.engine.TestExecutionResult;
+import org.junit.platform.launcher.TestExecutionListener;
+import org.junit.platform.launcher.TestIdentifier;
+import org.slf4j.*;
+
+public class ExecutionListener implements TestExecutionListener {
+
+ static Logger logger = LoggerFactory.getLogger("Test Execution Listener");
+ static Marker marker = MarkerFactory.getMarker("Starting");
+ static Marker endMarker = MarkerFactory.getMarker("Finished");
+ static Marker failMarker = MarkerFactory.getMarker("Failed");
+ static Marker assumeFailMarker = MarkerFactory.getMarker("Assumption Failed");
+ static Marker ignoredMarker = MarkerFactory.getMarker("Ignored");
+ static Marker skippedMarker = MarkerFactory.getMarker("Skipped");
+
+ @Override
+ public void executionSkipped(TestIdentifier testIdentifier, String reason) {
+ logger.info(ignoredMarker, "{} {}", testIdentifier.getDisplayName(), reason);
+ }
+
+ @Override
+ public void executionStarted(TestIdentifier testIdentifier) {
+ logger.info(marker, "{} {}", testIdentifier.getType(), testIdentifier.getDisplayName());
+ }
+
+ @Override
+ public void executionFinished(TestIdentifier testIdentifier, TestExecutionResult testExecutionResult) {
+ MDC.put("result", testExecutionResult.getStatus().toString());
+ switch (testExecutionResult.getStatus()) {
+ case FAILED:
+ logger.error(failMarker, "{}", testIdentifier.getDisplayName());
+ break;
+ case ABORTED:
+ logger.warn(ignoredMarker, "{}", testIdentifier.getDisplayName());
+ break;
+ case SUCCESSFUL:
+ logger.info(endMarker,"{}", testIdentifier.getDisplayName());
+ }
+ MDC.clear();
+ }
+}
diff --git a/database/src/test/java/org/linguafranca/util/TestUtil.java b/database/src/test/java/org/linguafranca/util/TestUtil.java
new file mode 100644
index 00000000..7778f021
--- /dev/null
+++ b/database/src/test/java/org/linguafranca/util/TestUtil.java
@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.util;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.PrintStream;
+
+public class TestUtil {
+
+ /**
+ * Database save closes output stream. If you want to output to console using KdbxFormat.None and System.out
+ * then use this class to wrap System.out, so that it doesn't get closed.
+ */
+ public static class UncloseableOutputStream extends OutputStream {
+
+ private final OutputStream outputStream;
+
+ public UncloseableOutputStream(OutputStream outputStream) {
+ this.outputStream = outputStream;
+ }
+
+ @Override
+ public void write(int b) throws IOException {
+ outputStream.write(b);
+ }
+
+ @Override
+ public void close() throws IOException {
+ // do nothing
+ }
+ }
+
+ /**
+ * Null output stream, i.e. throw away everything that is written to it. Useful during builds
+ * when you don't want to see the output - e.g. CI builds.
+ */
+ public static class NullOutputStream extends OutputStream {
+
+ @Override
+ public void write(int b) throws IOException {}
+ }
+
+ /**
+ * Get a print stream that will not close System.out, but will throw away all output
+ * if "enableConsoleOutput" system property has been not set - e.g. as a result of using
+ * mvn clean install -P enableConsoleOutput.
+ */
+ public static PrintStream getTestPrintStream() {
+ return !Boolean.getBoolean("enableConsoleOutput")
+ ? new PrintStream(new UncloseableOutputStream(System.out))
+ : new PrintStream(new NullOutputStream());
+ }
+}
\ No newline at end of file
diff --git a/database/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener b/database/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener
new file mode 100644
index 00000000..c5b20de5
--- /dev/null
+++ b/database/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener
@@ -0,0 +1,17 @@
+#
+# Copyright (c) 2025. Jo Rabin
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+#
+org.linguafranca.util.ExecutionListener
\ No newline at end of file
diff --git a/database/src/test/resources/junit-platform.properties b/database/src/test/resources/junit-platform.properties
new file mode 100644
index 00000000..2115a2f1
--- /dev/null
+++ b/database/src/test/resources/junit-platform.properties
@@ -0,0 +1 @@
+junit.jupiter.execution.parallel.enabled = true
diff --git a/dom/pom.xml b/dom/pom.xml
deleted file mode 100644
index fa44bcb4..00000000
--- a/dom/pom.xml
+++ /dev/null
@@ -1,38 +0,0 @@
-
-
-
- KeePassJava2-parent
- org.linguafranca.pwdb
- 2.2.3-SNAPSHOT
- ../pom.xml
-
- 4.0.0
-
- KeePassJava2-dom
- KeePassJava2 :: DOM
-
-
-
- org.linguafranca.pwdb
- KeePassJava2-kdbx
- ${project.version}
-
-
- org.linguafranca.pwdb
- test
- ${project.version}
- test
-
-
- junit
- junit
- test
-
-
- org.linguafranca.pwdb
- test
- 2.2.3-SNAPSHOT
- compile
-
-
-
\ No newline at end of file
diff --git a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapper.java b/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapper.java
deleted file mode 100644
index d6ba2513..00000000
--- a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapper.java
+++ /dev/null
@@ -1,223 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.jetbrains.annotations.NotNull;
-import org.linguafranca.pwdb.Credentials;
-import org.linguafranca.pwdb.StreamConfiguration;
-import org.linguafranca.pwdb.StreamFormat;
-import org.linguafranca.pwdb.base.AbstractDatabase;
-import org.linguafranca.pwdb.kdbx.Helpers;
-import org.linguafranca.pwdb.kdbx.KdbxHeader;
-import org.linguafranca.pwdb.kdbx.KdbxStreamFormat;
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-
-import javax.xml.xpath.XPathConstants;
-import javax.xml.xpath.XPathExpressionException;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.util.Objects;
-import java.util.UUID;
-
-import static com.google.common.base.Preconditions.checkNotNull;
-import static org.linguafranca.pwdb.kdbx.Helpers.base64FromUuid;
-import static org.linguafranca.pwdb.kdbx.dom.DomHelper.*;
-
-/**
- * The class wraps a {@link DomSerializableDatabase} as a {@link org.linguafranca.pwdb.Database}.
- *
- * @author jo
- */
-public class DomDatabaseWrapper extends AbstractDatabase {
-
- private final DomSerializableDatabase domDatabase = DomSerializableDatabase.createEmptyDatabase();
- Element dbMeta;
- private Document document;
- private Element dbRootGroup;
-
-
- private StreamFormat streamFormat;
-
-
- public DomDatabaseWrapper() {
- init();
- }
-
- /**
- * load a database
- * @param credentials credentials to use
- * @param inputStream where to read from
- * @return a database
- */
- public DomDatabaseWrapper(Credentials credentials, InputStream inputStream) throws IOException {
- this.streamFormat = new KdbxStreamFormat();
- streamFormat.load(domDatabase, credentials, inputStream);
- init();
- }
-
- /**
- * load a database
- * @param credentials credentials to use
- * @param inputStream where to read from
- * @return a database
- */
- public static DomDatabaseWrapper load(@NotNull Credentials credentials,
- @NotNull InputStream inputStream) throws IOException {
- return new DomDatabaseWrapper(
- checkNotNull(credentials, "Credentials must not be null"),
- checkNotNull(inputStream, "InputStream must not be null"));
- }
-
- private void init() {
- document = domDatabase.getDoc();
- try {
- dbRootGroup = ((Element) DomHelper.xpath.evaluate("/KeePassFile/Root/Group", document, XPathConstants.NODE));
- dbMeta = ((Element) DomHelper.xpath.evaluate("/KeePassFile/Meta", document, XPathConstants.NODE));
- } catch (XPathExpressionException e) {
- throw new IllegalStateException(e);
- }
- }
-
- /**
- * Save database with same format/encryption settings as it was loaded with or V4 defaults if was not loaded
- * @param credentials credentials to use
- * @param outputStream where to write
- */
- @Override
- public void save(Credentials credentials,
- OutputStream outputStream) throws IOException {
- if (Objects.isNull(streamFormat)){
- streamFormat = new KdbxStreamFormat(new KdbxHeader(4));
- }
- save(streamFormat, credentials, outputStream);
- }
-
- /**
- * Save database with same format/encryption settings as it was loaded with
- * @param streamFormat format/config to use for saving
- * @param credentials credentials to use
- * @param outputStream where to write
- */
- public void save(StreamFormat streamFormat,
- Credentials credentials,
- OutputStream outputStream) throws IOException {
- DomHelper.getElement("//Generator", domDatabase.getDoc().getDocumentElement(), false).setTextContent("KeePassJava2-DOM");
- streamFormat.save(domDatabase, credentials, outputStream);
- setDirty(false);
- }
-
- public boolean shouldProtect(String name) {
- Element protectionElement = DomHelper.getElement("MemoryProtection/Protect" + name, dbMeta, false);
- if (protectionElement == null) {
- return false;
- }
- return Boolean.parseBoolean(protectionElement.getTextContent());
- }
-
- @Override
- public DomGroupWrapper getRootGroup() {
- return new DomGroupWrapper(dbRootGroup, this, false);
- }
-
- @Override
- public DomGroupWrapper newGroup() {
- return new DomGroupWrapper(document.createElement(DomHelper.GROUP_ELEMENT_NAME), this, true);
- }
-
- @Override
- public DomEntryWrapper newEntry() {
- return new DomEntryWrapper(document.createElement(DomHelper.ENTRY_ELEMENT_NAME), this, true);
- }
-
- @Override
- public DomIconWrapper newIcon() {
- return new DomIconWrapper(document.createElement(DomHelper.ICON_ELEMENT_NAME));
- }
-
- @Override
- public DomIconWrapper newIcon(Integer i) {
- DomIconWrapper icon = newIcon();
- icon.setIndex(i);
- return icon;
- }
-
- @Override
- public DomGroupWrapper getRecycleBin() {
- String UuidContent = getElementContent(RECYCLE_BIN_UUID_ELEMENT_NAME, dbMeta);
- if (UuidContent != null) {
- final UUID uuid = Helpers.uuidFromBase64(UuidContent);
- if (uuid.getLeastSignificantBits() != 0 && uuid.getMostSignificantBits() != 0) {
- for (DomGroupWrapper g : getRootGroup().getGroups()) {
- if (g.getUuid().equals(uuid)) {
- return g;
- }
- }
- // the recycle bin seems to have been lost, better create another one
- }
- // uuid was 0 i.e. there isn't one
- }
- // no recycle bin group set up
- if (!isRecycleBinEnabled()) {
- return null;
- }
-
- DomGroupWrapper g = newGroup();
- g.setName("Recycle Bin");
- getRootGroup().addGroup(g);
- ensureElementContent(RECYCLE_BIN_UUID_ELEMENT_NAME, dbMeta, base64FromUuid(g.getUuid()));
- touchElement(RECYCLE_BIN_CHANGED_ELEMENT_NAME, dbMeta);
- return g;
- }
-
- @Override
- public boolean isRecycleBinEnabled() {
- return Boolean.parseBoolean(getElementContent(RECYCLE_BIN_ENABLED_ELEMENT_NAME, dbMeta));
- }
-
- @Override
- public void enableRecycleBin(boolean enable) {
- setElementContent(RECYCLE_BIN_ENABLED_ELEMENT_NAME, dbMeta, ((Boolean) enable).toString());
- }
-
- public String getName() {
- return DomHelper.getElementContent("DatabaseName", dbMeta);
- }
-
- public void setName(String name) {
- DomHelper.setElementContent("DatabaseName", dbMeta, name);
- DomHelper.touchElement("DatabaseNameChanged", dbMeta);
- setDirty(true);
- }
-
- @Override
- public String getDescription() {
- return DomHelper.getElementContent("DatabaseDescription", dbMeta);
- }
-
- @Override
- public void setDescription(String description) {
- DomHelper.setElementContent("DatabaseDescription", dbMeta, description);
- DomHelper.touchElement("DatabaseDescriptionChanged", dbMeta);
- setDirty(true);
- }
- public StreamFormat getStreamFormat() {
- return streamFormat;
- }
-}
diff --git a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomEntryWrapper.java b/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomEntryWrapper.java
deleted file mode 100644
index 39575301..00000000
--- a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomEntryWrapper.java
+++ /dev/null
@@ -1,226 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.base.AbstractEntry;
-import org.linguafranca.pwdb.kdbx.Helpers;
-import org.w3c.dom.Element;
-
-import java.util.*;
-
-/**
- * Class wraps Entries from a {@link DomSerializableDatabase} as {@link org.linguafranca.pwdb.Entry}
- *
- * @author jo
- */
-public class DomEntryWrapper extends AbstractEntry {
-
- private static Map mandatoryEntryElements = new HashMap() {{
- put(DomHelper.UUID_ELEMENT_NAME, new DomHelper.UuidValueCreator());
- put(DomHelper.ICON_ELEMENT_NAME, new DomHelper.ConstantValueCreator("2"));
- put(DomHelper.TIMES_ELEMENT_NAME, new DomHelper.ConstantValueCreator(""));
- put(DomHelper.LAST_MODIFICATION_TIME_ELEMENT_NAME, new DomHelper.DateValueCreator());
- put(DomHelper.CREATION_TIME_ELEMENT_NAME, new DomHelper.DateValueCreator());
- put(DomHelper.LAST_ACCESS_TIME_ELEMENT_NAME, new DomHelper.DateValueCreator());
- put(DomHelper.EXPIRY_TIME_ELEMENT_NAME, new DomHelper.DateValueCreator());
- put(DomHelper.EXPIRES_ELEMENT_NAME, new DomHelper.ConstantValueCreator("False"));
- put(DomHelper.USAGE_COUNT_ELEMENT_NAME, new DomHelper.ConstantValueCreator("0"));
- put(DomHelper.LOCATION_CHANGED, new DomHelper.DateValueCreator());
- }};
-
- final Element element;
- private final DomDatabaseWrapper database;
-
- public DomEntryWrapper(Element element, DomDatabaseWrapper database, boolean newElement) {
- this.element = element;
- this.database = database;
- if (newElement) {
- DomHelper.ensureElements(element, mandatoryEntryElements);
- ensureProperty("Notes");
- ensureProperty("Title");
- ensureProperty("URL");
- ensureProperty("UserName");
- ensureProperty("Password");
- }
- }
-
- @Override
- public String getProperty(String name) {
- Element property = DomHelper.getElement(String.format(DomHelper.PROPERTY_ELEMENT_FORMAT, name), element, false);
- if (property == null) {
- return null;
- }
- return DomHelper.getElementContent(DomHelper.VALUE_ELEMENT_NAME, property);
- }
-
- @Override
- public void setProperty(String name, String value) {
- Element property = DomHelper.getElement(String.format(DomHelper.PROPERTY_ELEMENT_FORMAT, name), element, false);
- if (property == null) {
- property = DomHelper.newElement("String", element);
- DomHelper.setElementContent("Key", property, name);
- }
- DomHelper.setElementContent(DomHelper.VALUE_ELEMENT_NAME, property, value);
- DomHelper.touchElement(DomHelper.LAST_MODIFICATION_TIME_ELEMENT_NAME, element);
- database.setDirty(true);
- }
-
- @Override
- public boolean removeProperty(String name) throws IllegalArgumentException {
- if (STANDARD_PROPERTY_NAMES.contains(name)) throw new IllegalArgumentException("may not remove property: " + name);
- boolean wasRemoved = DomHelper.removeElement(String.format(DomHelper.PROPERTY_ELEMENT_FORMAT, name), element);
- if (wasRemoved) database.setDirty(true);
- return wasRemoved;
- }
-
- @Override
- public List getPropertyNames() {
- ArrayList result = new ArrayList<>();
- List list = DomHelper.getElements("String", element);
- for (Element listElement: list) {
- result.add(DomHelper.getElementContent("Key", listElement));
- }
- return result;
- }
-
- @Override
- public byte[] getBinaryProperty(String name) {
- Element property = DomHelper.getElement(String.format(DomHelper.BINARY_PROPERTY_ELEMENT_FORMAT, name), element, false);
- if (property == null) {
- return null;
- }
- return DomHelper.getBinaryElementContent(DomHelper.VALUE_ELEMENT_NAME, property);
- }
-
- @Override
- public void setBinaryProperty(String name, byte[] value) {
- Element property = DomHelper.getElement(String.format(DomHelper.BINARY_PROPERTY_ELEMENT_FORMAT, name), element, false);
- if (property == null) {
- property = DomHelper.newElement("Binary", element);
- DomHelper.setElementContent("Key", property, name);
- }
- DomHelper.setBinaryElementContent(DomHelper.VALUE_ELEMENT_NAME, property, value);
- DomHelper.touchElement(DomHelper.LAST_MODIFICATION_TIME_ELEMENT_NAME, element);
- database.setDirty(true);
-
- }
-
- @Override
- public boolean removeBinaryProperty(String name) {
- boolean wasRemoved = DomHelper.removeElement(String.format(DomHelper.BINARY_PROPERTY_ELEMENT_FORMAT, name), element);
- if (wasRemoved) database.setDirty(true);
- return wasRemoved;
- }
-
- @Override
- public List getBinaryPropertyNames() {
- ArrayList result = new ArrayList<>();
- List list = DomHelper.getElements("Binary", element);
- for (Element listElement: list) {
- result.add(DomHelper.getElementContent("Key", listElement));
- }
- return result;
- }
-
- private void ensureProperty(String name){
- Element property = DomHelper.getElement(String.format(DomHelper.PROPERTY_ELEMENT_FORMAT, name), element, false);
- if (property == null) {
- Element container = DomHelper.newElement("String", element);
- DomHelper.setElementContent("Key", container, name);
- DomHelper.getElement("Value", container, true);
- }
- }
-
- @Override
- public DomGroupWrapper getParent() {
- if (element.getParentNode() == null) {
- return null;
- }
- return new DomGroupWrapper((Element) element.getParentNode(), database, false);
- }
-
- @Override
- public UUID getUuid() {
- return Helpers.uuidFromBase64(DomHelper.getElementContent(DomHelper.UUID_ELEMENT_NAME, element));
- }
-
- @Override
- public DomIconWrapper getIcon() {
- return new DomIconWrapper(DomHelper.getElement(DomHelper.ICON_ELEMENT_NAME, element, false));
- }
-
- @Override
- public void setIcon(DomIconWrapper icon) {
- DomHelper.getElement(DomHelper.ICON_ELEMENT_NAME, element, true).setTextContent(String.valueOf(icon.getIndex()));
- DomHelper.touchElement(DomHelper.LAST_MODIFICATION_TIME_ELEMENT_NAME, element);
- database.setDirty(true);
- }
-
- @Override
- public Date getLastAccessTime() {
- return Helpers.toDate(DomHelper.getElementContent(DomHelper.LAST_ACCESS_TIME_ELEMENT_NAME, element));
- }
-
- @Override
- public Date getCreationTime() {
- return Helpers.toDate(DomHelper.getElementContent(DomHelper.CREATION_TIME_ELEMENT_NAME, element));
- }
-
- @Override
- public boolean getExpires() {
- String content = DomHelper.getElementContent(DomHelper.EXPIRES_ELEMENT_NAME, element);
- return content != null && content.equalsIgnoreCase("true");
- }
-
- @Override
- public void setExpires(boolean expires) {
- DomHelper.setElementContent(DomHelper.EXPIRES_ELEMENT_NAME, element, expires ? "True" : "False");
- }
-
- @Override
- public Date getExpiryTime() {
- return Helpers.toDate(DomHelper.getElementContent(DomHelper.EXPIRY_TIME_ELEMENT_NAME, element));
- }
-
- @Override
- public void setExpiryTime(Date expiryTime) throws IllegalArgumentException {
- if (expiryTime == null) throw new IllegalArgumentException("expiryTime may not be null");
- String formatted = Helpers.fromDate(expiryTime);
- DomHelper.setElementContent(DomHelper.EXPIRY_TIME_ELEMENT_NAME, element, formatted);
- }
-
- @Override
- public Date getLastModificationTime() {
- return Helpers.toDate(DomHelper.getElementContent(DomHelper.LAST_MODIFICATION_TIME_ELEMENT_NAME, element));
- }
-
- @Override
- protected void touch() {
- DomHelper.setElementContent(DomHelper.LAST_MODIFICATION_TIME_ELEMENT_NAME, element, Helpers.fromDate(new Date()));
- }
-
- @Override
- public boolean equals(Object o) {
- if (this == o) return true;
- if (o == null || getClass() != o.getClass()) return false;
-
- DomEntryWrapper that = (DomEntryWrapper) o;
-
- return element.equals(that.element) && database.equals(that.database);
-
- }
-}
diff --git a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomGroupWrapper.java b/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomGroupWrapper.java
deleted file mode 100644
index 504cf848..00000000
--- a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomGroupWrapper.java
+++ /dev/null
@@ -1,219 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-import org.linguafranca.pwdb.Icon;
-import org.linguafranca.pwdb.base.AbstractGroup;
-import org.linguafranca.pwdb.kdbx.Helpers;
-import org.w3c.dom.Element;
-
-import java.util.*;
-
-import static org.linguafranca.pwdb.kdbx.dom.DomHelper.*;
-
-
-/**
- * Class wraps Groups from a {@link DomSerializableDatabase} as {@link org.linguafranca.pwdb.Group}
- *
- * @author jo
- */
-public class DomGroupWrapper extends AbstractGroup {
-
- static Map mandatoryGroupElements = new HashMap() {{
- put(UUID_ELEMENT_NAME, new UuidValueCreator());
- put(NAME_ELEMENT_NAME, new ConstantValueCreator(""));
- put(NOTES_ELEMENT_NAME, new ConstantValueCreator(""));
- put(ICON_ELEMENT_NAME, new ConstantValueCreator("0"));
- put(TIMES_ELEMENT_NAME, new ConstantValueCreator(""));
- put(LAST_MODIFICATION_TIME_ELEMENT_NAME, new DateValueCreator());
- put(CREATION_TIME_ELEMENT_NAME, new DateValueCreator());
- put(LAST_ACCESS_TIME_ELEMENT_NAME, new DateValueCreator());
- put(EXPIRY_TIME_ELEMENT_NAME, new DateValueCreator());
- put(EXPIRES_ELEMENT_NAME, new ConstantValueCreator("False"));
- put(USAGE_COUNT_ELEMENT_NAME, new ConstantValueCreator("0"));
- put(LOCATION_CHANGED, new DateValueCreator());
- }};
-
-
- private final Element element;
- private final DomDatabaseWrapper database;
-
- public DomGroupWrapper(Element element, DomDatabaseWrapper database, boolean newGroup) {
- this.database = database;
- this.element = element;
- if (newGroup) {
- ensureElements(this.element, mandatoryGroupElements);
- }
- }
-
- @Override
- public boolean isRootGroup() {
- Element parent = ((Element) element.getParentNode());
- return parent != null && (parent.getTagName().equals("Root"));
- }
-
- @Override
- public boolean isRecycleBin() {
- String UUIDcontent = getElementContent(RECYCLE_BIN_UUID_ELEMENT_NAME, database.dbMeta);
- if (UUIDcontent != null){
- UUID uuid = Helpers.uuidFromBase64(UUIDcontent);
- return uuid.equals(this.getUuid());
- }
- return false;
- }
-
- @Override
- public @Nullable DomGroupWrapper getParent() {
- Element parent = ((Element) element.getParentNode());
- if (parent == null) {
- return null;
- }
- // if the element is the root group there is no parent
- if (element == element.getOwnerDocument().getDocumentElement().getElementsByTagName(GROUP_ELEMENT_NAME).item(0)){
- return null;
- }
- return new DomGroupWrapper(parent, database, false);
- }
-
- @Override
- public void setParent(DomGroupWrapper parent) {
- parent.addGroup(this);
- }
-
- @Override
- public List getGroups() {
- List elements = getElements(GROUP_ELEMENT_NAME, this.element);
- List result = new ArrayList<>(elements.size());
- for (Element e: elements){
- result.add(new DomGroupWrapper(e, database, false));
- }
- return result;
- }
-
- @Override
- public int getGroupsCount() {
- List elements = getElements(GROUP_ELEMENT_NAME, this.element);
- return elements.size();
- }
-
- @Override
- public DomGroupWrapper addGroup(DomGroupWrapper group) {
- if (group.isRootGroup()) {
- throw new IllegalStateException("Cannot set root group as child of another group");
- }
- // skip if this is a new group with no parent
- if (group.getParent() != null) {
- group.getParent().touch();
- group.getParent().removeGroup(group);
- }
- element.appendChild(group.element);
- touchElement("Times/LocationChanged", group.element);
- touch();
- return group;
- }
-
- @Override
- public DomGroupWrapper removeGroup(DomGroupWrapper g1) {
- element.removeChild(g1.element);
- database.setDirty(true);
- return g1;
- }
-
- @Override
- public List getEntries() {
- List elements = getElements(ENTRY_ELEMENT_NAME, this.element);
- List entries = new ArrayList<>(elements.size());
- for(Element e: elements) {
- entries.add(new DomEntryWrapper(e, database, false));
- }
- return entries;
- }
-
- @Override
- public int getEntriesCount() {
- return getElementsCount(ENTRY_ELEMENT_NAME, this.element);
- }
-
- @Override
- public DomEntryWrapper addEntry(DomEntryWrapper entry) {
- if (entry.getParent() != null) {
- entry.element.getParentNode().removeChild(element);
- }
- element.appendChild(entry.element);
- database.setDirty(true);
- return entry;
- }
-
- @Override
- public DomEntryWrapper removeEntry(DomEntryWrapper e12) {
- element.removeChild(e12.element);
- database.setDirty(true);
- return e12;
- }
-
- @Override
- public String getName() {
- return getElementContent(NAME_ELEMENT_NAME, element);
- }
-
- @Override
- public void setName(String name) {
- setElementContent(NAME_ELEMENT_NAME, element, name);
- database.setDirty(true);
- }
-
- @Override
- public UUID getUuid() {
- String encodedUuid = getElementContent(UUID_ELEMENT_NAME, element);
- return Helpers.uuidFromBase64(encodedUuid);
- }
-
- @Override
- public DomIconWrapper getIcon() {
- return new DomIconWrapper(getElement(ICON_ELEMENT_NAME, element, false));
- }
-
- @Override
- public void setIcon(DomIconWrapper icon) {
- setElementContent(ICON_ELEMENT_NAME, element, String.valueOf(icon.getIndex()));
- database.setDirty(true);
- }
-
- @NotNull
- @Override
- public DomDatabaseWrapper getDatabase() {
- return database;
- }
-
- @Override
- public boolean equals(Object o) {
- if (this == o) return true;
- if (o == null || getClass() != o.getClass()) return false;
-
- DomGroupWrapper that = (DomGroupWrapper) o;
-
- return element.equals(that.element) && database.equals(that.database);
-
- }
-
- private void touch() {
- touchElement(LAST_MODIFICATION_TIME_ELEMENT_NAME, this.element);
- this.database.setDirty(true);
- }
-}
diff --git a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomIconWrapper.java b/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomIconWrapper.java
deleted file mode 100644
index b965e143..00000000
--- a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomIconWrapper.java
+++ /dev/null
@@ -1,55 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.Icon;
-import org.w3c.dom.Element;
-
-/**
- * Class wraps Icons from a {@link DomSerializableDatabase} as {@link Icon}
- *
- * @author jo
- */
-public class DomIconWrapper implements Icon {
-
- private final Element element;
-
- public DomIconWrapper(Element element) {
- this.element = element;
- }
-
- @Override
- public int getIndex() {
- return Integer.parseInt(element.getTextContent());
- }
-
- @Override
- public void setIndex(int index) {
- element.setTextContent(String.valueOf(index));
- }
-
- @Override
- public boolean equals(Object o) {
- if (this == o) return true;
- if (o == null || !(o instanceof Icon)) return false;
-
- Icon that = (Icon) o;
-
- return this.getIndex() == that.getIndex();
-
- }
-}
diff --git a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomPropertyValueTest.java b/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomPropertyValueTest.java
deleted file mode 100644
index c695129a..00000000
--- a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomPropertyValueTest.java
+++ /dev/null
@@ -1,57 +0,0 @@
-/*
- * Copyright 2024 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.Credentials;
-import org.linguafranca.pwdb.Database;
-import org.linguafranca.pwdb.checks.PropertyValueChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-
-public class DomPropertyValueTest extends PropertyValueChecks {
-
- public DomPropertyValueTest() throws IOException {
- super(false);
- }
-
-
- @Override
- public Database createDatabase() throws IOException {
- return new DomDatabaseWrapper();
- }
-
- @Override
- public void saveDatabase(Database database, Credentials credentials, OutputStream outputStream) throws IOException {
- database.save(credentials, outputStream);
- }
-
- @Override
- public Database loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- try {
- return DomDatabaseWrapper.load(credentials, inputStream);
- } catch (Exception e) {
- throw new IOException(e);
- }
- }
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds(creds);
- }
-}
diff --git a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomSerializableDatabase.java b/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomSerializableDatabase.java
deleted file mode 100644
index 9bfe4fce..00000000
--- a/dom/src/main/java/org/linguafranca/pwdb/kdbx/dom/DomSerializableDatabase.java
+++ /dev/null
@@ -1,245 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-
-import org.linguafranca.pwdb.kdbx.Helpers;
-import org.linguafranca.pwdb.SerializableDatabase;
-import org.linguafranca.pwdb.security.StreamEncryptor;
-import org.apache.commons.codec.binary.Base64;
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-import org.xml.sax.SAXException;
-
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.transform.*;
-import javax.xml.transform.dom.DOMSource;
-import javax.xml.transform.stream.StreamResult;
-import javax.xml.xpath.XPathConstants;
-import javax.xml.xpath.XPathExpressionException;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.nio.charset.StandardCharsets;
-import java.time.Instant;
-import java.util.Date;
-
-/**
- * This class is an XML DOM implementation of a KDBX database. The data is maintained as a DOM,
- * despite the obvious inefficiency of doing do, in order to maintain transparency on loading and
- * saving of elements and attributes this implementation knows nothing about.
- *
- *
Obviously, perhaps, if the database is added to, or under certain types of modification,
- * those elements will be missing from a re-serialization.
- *
- * @author jo
- */
-public class DomSerializableDatabase implements SerializableDatabase {
-
- private Document doc;
- private StreamEncryptor encryption;
-
- private DomSerializableDatabase() {}
-
- public static DomSerializableDatabase createEmptyDatabase() {
- DomSerializableDatabase result = new DomSerializableDatabase();
- // read in the template KeePass XML database
- try {
- result.load(result.getClass().getClassLoader().getResourceAsStream("base.kdbx.xml"));
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
- try {
- // set the root group UUID
- Node uuid = (Node) DomHelper.xpath.evaluate("//"+ DomHelper.UUID_ELEMENT_NAME, result.doc.getDocumentElement(), XPathConstants.NODE);
- uuid.setTextContent(DomHelper.base64RandomUuid());
- } catch (XPathExpressionException e) {
- throw new IllegalStateException(e);
- }
- return result;
- }
-
- @Override
- public SerializableDatabase load(InputStream inputStream) throws IOException {
- DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
- try {
- DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
- doc = dBuilder.parse(inputStream);
-
- // we need to decrypt all protected fields
- NodeList protectedContent = (NodeList) DomHelper.xpath.evaluate("//*[@Protected='True']", doc, XPathConstants.NODESET);
- for (int i = 0; i < protectedContent.getLength(); i++){
- Element element = ((Element) protectedContent.item(i));
- String base64 = DomHelper.getElementContent(".", element);
- // Android compatibility
- byte[] encrypted = Base64.decodeBase64(base64.getBytes());
- String decrypted = new String(encryption.decrypt(encrypted), StandardCharsets.UTF_8);
- DomHelper.setElementContent(".", element, decrypted);
- element.removeAttribute("Protected");
- element.setAttribute("kpj2-ProtectOnOutput", "True");
- }
- return this;
-
- } catch (ParserConfigurationException e) {
- throw new IllegalStateException("Instantiating Document Builder", e);
- } catch (SAXException e) {
- throw new IllegalStateException("Parsing exception", e);
- } catch (XPathExpressionException e) {
- throw new IllegalStateException("XPath Exception", e);
- }
- }
-
- @Override
- public void addBinary(int index, byte[] payload) {
- DomHelper.addBinary(doc.getDocumentElement(), Helpers.encodeBase64Content(payload, true),index);
- }
-
- @Override
- public byte[] getBinary(int index) {
- return Helpers.decodeBase64Content(DomHelper.getBinary(doc.getDocumentElement(), index).getBytes(StandardCharsets.UTF_8), true);
- }
-
- @Override
- public int getBinaryCount() {
- return DomHelper.getBinaryCount(doc.getDocumentElement());
- }
-
- @Override
- public void save(OutputStream outputStream) {
- // make a copy so we can mess with content
- Document copyDoc = (Document) doc.cloneNode(true);
- try {
- // check whether protection is required by default and if so mark the element with @@kpj2-ProtectOnOutput='True'
- prepareProtection(copyDoc, "Title");
- prepareProtection(copyDoc, "UserName");
- prepareProtection(copyDoc, "Password");
- prepareProtection(copyDoc, "Notes");
- prepareProtection(copyDoc, "URL");
-
- // encrypt and base64 every element marked as protected
- NodeList protectedContent = (NodeList) DomHelper.xpath.evaluate("//*[@kpj2-ProtectOnOutput='True']", copyDoc, XPathConstants.NODESET);
- for (int i = 0; i < protectedContent.getLength(); i++){
- Element element = ((Element) protectedContent.item(i));
-
- element.removeAttribute("kpj2-ProtectOnOutput");
- element.setAttribute("Protected", "True");
-
- String decrypted = DomHelper.getElementContent(".", element);
- if (decrypted == null) {
- decrypted = "";
- }
- byte[] encrypted = encryption.encrypt(decrypted.getBytes());
- // Android compatibility
- String base64 = new String(Base64.encodeBase64(encrypted));
- DomHelper.setElementContent(".", element, base64);
- }
-
- // we need to serialise dates according to the format, and
- // we are going to say that anything that is a date is called *Changed or *Time
- // because that does work in the schema, but won't work for custom values
- NodeList timeBasedContent = (NodeList) DomHelper.xpath.evaluate(
- //"//*[ends-with(name(), 'Changed')] | //*[ends-with(name(), 'Time')]",
- // dealing with XPath1
- "//*[substring(name(),string-length(name())-6) = 'Changed'] | //*[substring(name(),string-length(name())-3) = 'Time']",
- copyDoc,
- XPathConstants.NODESET);
- for (int i = 0; i < timeBasedContent.getLength(); i++){
- Element element = ((Element) timeBasedContent.item(i));
- String time = DomHelper.getElementContent(".", element);
- Date date;
- if (time.equals("${creationDate}")) {
- date = Date.from(Instant.now());
- } else {
- date = Helpers.toDate(time);
- }
- String encoded = Helpers.fromDate(date);
- DomHelper.setElementContent(".", element, encoded);
- }
-
- } catch (XPathExpressionException e) {
- throw new IllegalStateException(e);
- }
-
- Source xmlSource = new DOMSource(copyDoc);
- try {
- TransformerFactory factory = TransformerFactory.newInstance();
- //factory.setAttribute("indent-number", "4");
- Transformer transformer = factory.newTransformer();
- transformer.setOutputProperty(OutputKeys.INDENT, "yes");
- //noinspection HttpUrlsUsage
- transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
- transformer.transform(xmlSource, new StreamResult(outputStream));
- } catch (TransformerException e) {
- throw new IllegalStateException(e);
- }
- }
-
- private static final String protectQuery = "//Meta/MemoryProtection/Protect%s";
- private static final String pattern = "//String/Key[text()='%s']/following-sibling::Value";
- private void prepareProtection(Document doc, String protect) throws XPathExpressionException {
- // does this require encryption
- String query = String.format(protectQuery, protect);
- if (!((String) DomHelper.xpath.evaluate(query, doc, XPathConstants.STRING)).equalsIgnoreCase("true")) {
- return;
- }
- // mark the field as Protected but don't actually encrypt yet, that comes later
- String path = String.format(pattern, protect);
- NodeList nodelist = (NodeList) DomHelper.xpath.evaluate(path, doc, XPathConstants.NODESET);
- for (int i = 0; i < nodelist.getLength(); i++) {
- Element element = (Element) nodelist.item(i);
- element.setAttribute("kpj2-ProtectOnOutput", "True");
- }
- }
-
- @Override
- public byte[] getHeaderHash() {
- try {
- String base64 = (String) DomHelper.xpath.evaluate("//HeaderHash", doc, XPathConstants.STRING);
- // Android compatibility
- return Base64.decodeBase64(base64.getBytes());
- } catch (XPathExpressionException e) {
- throw new IllegalStateException("Can't get header hash", e);
- }
- }
-
- @Override
- public void setHeaderHash(byte[] hash) {
- // Android compatibility
- String base64String = new String(Base64.encodeBase64(hash));
- DomHelper.ensureElementContent("Meta/HeaderHash", doc.getDocumentElement(), base64String);
- //((Element) DomHelper.xpath.evaluate("//HeaderHash", doc, XPathConstants.NODE)).setTextContent(base64String);
- }
-
-
- @Override
- public StreamEncryptor getEncryption() {
- return encryption;
- }
-
- @Override
- public void setEncryption(StreamEncryptor encryption) {
- this.encryption = encryption;
- }
-
- public Document getDoc() {
- return doc;
- }
-}
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomBinaryPropertyV3Test.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomBinaryPropertyV3Test.java
deleted file mode 100644
index 58ccdebc..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomBinaryPropertyV3Test.java
+++ /dev/null
@@ -1,57 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.checks.BinaryPropertyChecks;
-import org.linguafranca.pwdb.Database;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.Credentials;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-
-/**
- * @author jo
- */
-public class DomBinaryPropertyV3Test extends BinaryPropertyChecks {
-
- public DomBinaryPropertyV3Test() throws IOException {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("Attachment.kdbx");
- database = DomDatabaseWrapper.load(new KdbxCreds("123".getBytes()), inputStream);
- }
-
- @Override
- public void saveDatabase(Database database, Credentials credentials, OutputStream outputStream) throws IOException {
- database.save(credentials, outputStream);
- }
-
- @Override
- public Database loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- return DomDatabaseWrapper.load(credentials, inputStream);
- }
-
- @Override
- public Database newDatabase() {
- return new DomDatabaseWrapper();
- }
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds(creds);
- }
-}
\ No newline at end of file
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomBinaryPropertyV4Test.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomBinaryPropertyV4Test.java
deleted file mode 100644
index 97499e18..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomBinaryPropertyV4Test.java
+++ /dev/null
@@ -1,63 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.Credentials;
-import org.linguafranca.pwdb.Database;
-import org.linguafranca.pwdb.StreamFormat;
-import org.linguafranca.pwdb.checks.BinaryPropertyChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.KdbxHeader;
-import org.linguafranca.pwdb.kdbx.KdbxStreamFormat;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-
-/**
- * @author jo
- */
-public class DomBinaryPropertyV4Test extends BinaryPropertyChecks {
-
- public DomBinaryPropertyV4Test() throws IOException {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("V4-ChaCha20-Argon2-Attachment.kdbx");
- database = DomDatabaseWrapper.load(new KdbxCreds("123".getBytes()), inputStream);
- }
-
- @Override
- public void saveDatabase(Database database, Credentials credentials, OutputStream outputStream) throws IOException {
- StreamFormat sf = new KdbxStreamFormat(new KdbxHeader(4));
- database.save(sf, credentials, outputStream);
- }
-
-
- @Override
- public Database loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- return DomDatabaseWrapper.load(credentials, inputStream);
- }
-
- @Override
- public Database newDatabase() {
- return new DomDatabaseWrapper();
- }
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds(creds);
- }
-
-}
\ No newline at end of file
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapperLoaderTest.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapperLoaderTest.java
deleted file mode 100644
index e980f98a..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapperLoaderTest.java
+++ /dev/null
@@ -1,41 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.checks.DatabaseLoaderChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.Credentials;
-
-import java.io.IOException;
-import java.io.InputStream;
-
-/**
- * @author jo
- */
-public class DomDatabaseWrapperLoaderTest extends DatabaseLoaderChecks {
-
- public DomDatabaseWrapperLoaderTest() throws IOException {
- // get an input stream from kdbx file
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("test123.kdbx");
- // file has password credentials
- Credentials credentials = new KdbxCreds("123".getBytes());
- // open database. DomDatabaseWrapper is so-called, since it wraps
- // a W3C DOM, populated from the KeePass XML, and presents it
- // through a org.linguafranca.keepass.Database interface.
- super.database = DomDatabaseWrapper.load(credentials, inputStream);
- }
-}
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapperTest.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapperTest.java
deleted file mode 100644
index aef78d3d..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomDatabaseWrapperTest.java
+++ /dev/null
@@ -1,65 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.checks.BasicDatabaseChecks;
-import org.junit.Test;
-import org.linguafranca.pwdb.Database;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.KdbxStreamFormat;
-import org.linguafranca.pwdb.StreamFormat;
-import org.linguafranca.pwdb.Credentials;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.PrintStream;
-
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-/**
- * @author jo
- */
-public class DomDatabaseWrapperTest extends BasicDatabaseChecks {
-
- static PrintStream printStream = getTestPrintStream();
-
- public DomDatabaseWrapperTest() throws IOException {
- }
-
- @Test
- public void inspectPasswordDatabase() throws IOException {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("test123.kdbx");
- DomDatabaseWrapper database = new DomDatabaseWrapper(new KdbxCreds("123".getBytes()), inputStream);
-
- database.save(new StreamFormat.None(), new Credentials.None(), printStream);
- }
-
- @Test
- public void inspectKeyfileDatabase() throws IOException {
- InputStream keyFileInputStream = getClass().getClassLoader().getResourceAsStream("KeyFileDatabase.key");
- Credentials credentials = new KdbxCreds("123".getBytes(), keyFileInputStream);
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("KeyFileDatabase.kdbx");
- DomDatabaseWrapper database = new DomDatabaseWrapper(credentials, inputStream);
-
- database.save(new StreamFormat.None(), new Credentials.None(), printStream);
- }
-
- @Override
- public Database createDatabase() throws IOException {
- return new DomDatabaseWrapper();
- }
-}
\ No newline at end of file
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomHelperTest.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomHelperTest.java
deleted file mode 100644
index 227b5e3e..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomHelperTest.java
+++ /dev/null
@@ -1,42 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.junit.Test;
-import org.linguafranca.pwdb.kdbx.Helpers;
-
-import java.io.PrintStream;
-
-import static org.junit.Assert.assertEquals;
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-/**
- * @author jo
- */
-public class DomHelperTest {
-
- static PrintStream printStream = getTestPrintStream();
-
- @Test
- public void testBase64RandomUuid() throws Exception {
- // just check that it can do something
- String uuid1 = DomHelper.base64RandomUuid();
- printStream.println(Helpers.uuidFromBase64(uuid1));
- String uuid2 = DomHelper.base64RandomUuid();
- printStream.println(Helpers.uuidFromBase64(uuid2));
- }
-}
\ No newline at end of file
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomRecycleBinTest.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomRecycleBinTest.java
deleted file mode 100644
index 9502ff6e..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomRecycleBinTest.java
+++ /dev/null
@@ -1,14 +0,0 @@
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.checks.RecycleBinChecks;
-
-import java.io.IOException;
-
-/**
- * @author jo
- */
-public class DomRecycleBinTest extends RecycleBinChecks {
- public DomRecycleBinTest() throws IOException {
- database = new DomDatabaseWrapper();
- }
-}
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomSaveAndReloadTest.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomSaveAndReloadTest.java
deleted file mode 100644
index 704f0a72..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomSaveAndReloadTest.java
+++ /dev/null
@@ -1,70 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.linguafranca.pwdb.StreamFormat;
-import org.linguafranca.pwdb.checks.SaveAndReloadChecks;
-import org.linguafranca.pwdb.Database;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.Credentials;
-import org.linguafranca.pwdb.kdbx.KdbxHeader;
-import org.linguafranca.pwdb.kdbx.KdbxStreamFormat;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-
-/**
- * @author jo
- */
-public class DomSaveAndReloadTest extends SaveAndReloadChecks {
-
- @Override
- public Database getDatabase() {
- return new DomDatabaseWrapper();
- }
- @Override
- public Database getDatabase(String name, Credentials credentials) throws IOException {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream(name);
- return DomDatabaseWrapper.load(credentials, inputStream);
- }
-
- @Override
- public void saveDatabase(Database database, Credentials credentials, OutputStream outputStream) throws IOException {
- database.save(credentials, outputStream);
- }
-
- @Override
- public Database loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- return DomDatabaseWrapper.load(credentials, inputStream);
- }
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds("123".getBytes());
- }
-
- @Override
- public boolean verifyStreamFormat(StreamFormat s1, StreamFormat s2) {
- KdbxHeader h1 = (KdbxHeader) s1.getStreamConfiguration();
- KdbxHeader h2 = (KdbxHeader) s1.getStreamConfiguration();
- return (h1.getVersion() == h2.getVersion() &&
- h1.getProtectedStreamAlgorithm().equals(h2.getProtectedStreamAlgorithm()) &&
- h1.getKeyDerivationFunction().equals(h2.getKeyDerivationFunction()) &&
- h1.getCipherAlgorithm().equals(h2.getCipherAlgorithm()));
- }
-}
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomV4Test.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomV4Test.java
deleted file mode 100644
index d3ad03a2..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/DomV4Test.java
+++ /dev/null
@@ -1,34 +0,0 @@
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.junit.Test;
-import org.linguafranca.pwdb.Visitor;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-
-import java.io.InputStream;
-import java.io.PrintStream;
-
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-/**
- * @author jo
- */
-public class DomV4Test {
-
- static PrintStream printStream = getTestPrintStream();
-
- @Test
- public void loadKdbxV4() throws Exception {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("V4-AES-Argon2.kdbx");
- DomDatabaseWrapper database = DomDatabaseWrapper.load(new KdbxCreds("123".getBytes()), inputStream);
- database.visit(new Visitor.Print(printStream));
- // test what happens to dates in V4
- database.visit(new Visitor.Default(){
-
- @Override
- public void visit(DomEntryWrapper entry) {
- printStream.println(entry.getCreationTime());
- }
- });
- }
-
-}
diff --git a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/VisitorTest.java b/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/VisitorTest.java
deleted file mode 100644
index 199c78b9..00000000
--- a/dom/src/test/java/org/linguafranca/pwdb/kdbx/dom/VisitorTest.java
+++ /dev/null
@@ -1,95 +0,0 @@
-/*
- * Copyright 2015 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb.kdbx.dom;
-
-import org.junit.Assert;
-import org.junit.Test;
-import org.linguafranca.pwdb.Group;
-import org.linguafranca.pwdb.Entry;
-import org.linguafranca.pwdb.Visitor;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.KdbxStreamFormat;
-
-import java.io.InputStream;
-import java.io.PrintStream;
-import java.util.ArrayList;
-import java.util.List;
-
-import static org.junit.Assert.assertTrue;
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-/**
- * @author Jo
- */
-public class VisitorTest {
-
- static PrintStream printStream = getTestPrintStream();
-
- private List visitorList = new ArrayList<>();
- private Visitor visitor = new Visitor() {
- StringBuffer indentation = new StringBuffer();
- @Override
- public void startVisit(Group group) {
- printStream.println(indentation.toString() + group.getName());
- indentation.append(" ");
- }
-
- @Override
- public void endVisit(Group group) {
- indentation.setLength(indentation.length()-3);
- }
-
- @Override
- public boolean isEntriesFirst() {
- return false;
- }
-
- @Override
- public void visit(Entry entry) {
- printStream.println(indentation.toString() + "= " + entry.getTitle());
- visitorList.add(entry);
- }
- };
-
- @Test
- public void testLoadDB() {
- try {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("test123.kdbx");
- DomDatabaseWrapper db = new DomDatabaseWrapper(new KdbxCreds("123".getBytes()), inputStream);
- db.visit(visitor);
-
- //noinspection unchecked
- List matched = db.findEntries(new Entry.Matcher() {
- String matchee = "";
- @Override
- public boolean matches(Entry entry) {
- return entry.getTitle().toLowerCase().contains(matchee) ||
- entry.getNotes().toLowerCase().contains(matchee) ||
- entry.getUsername().toLowerCase().contains(matchee);
- }
- });
-
- Assert.assertTrue(matched.size() == visitorList.size());
-
- for (Entry e: matched) {
- Assert.assertTrue(visitorList.contains(e));
- }
- } catch (Exception e) {
- Assert.assertTrue("Couldn\'t open test DB " + e.getMessage(), false);
- }
- }
-}
diff --git a/example/pom.xml b/example/pom.xml
index 7cfde215..2bbba5a6 100644
--- a/example/pom.xml
+++ b/example/pom.xml
@@ -1,25 +1,26 @@
- KeePassJava2-parent
- org.linguafranca.pwdb
- 2.2.3-SNAPSHOT
+ KeePassJava2.parent
+ mh.keepass
+ 1.0.0.1../pom.xml4.0.0
@@ -34,19 +35,23 @@
- org.linguafranca.pwdb
+ mh.keepassKeePassJava2${project.version}
- org.linguafranca.pwdb
- test
- ${project.version}
+ org.slf4j
+ slf4j-api
- io.github.novacrypto
- SecureString
- 2022.01.17
+ ch.qos.logback
+ logback-classic
+
+
+ mh.keepass
+ database
+ ${project.version}
+ test-jar
diff --git a/example/src/main/java/org/linguafranca/pwdb/example/SecureCharBufferPropertyValue.java b/example/src/main/java/org/linguafranca/pwdb/example/SecureCharBufferPropertyValue.java
deleted file mode 100644
index 0b84d4ae..00000000
--- a/example/src/main/java/org/linguafranca/pwdb/example/SecureCharBufferPropertyValue.java
+++ /dev/null
@@ -1,76 +0,0 @@
-package org.linguafranca.pwdb.example;
-
-import io.github.novacrypto.SecureCharBuffer;
-import org.linguafranca.pwdb.PropertyValue;
-
-import java.nio.ByteBuffer;
-import java.nio.CharBuffer;
-import java.nio.charset.StandardCharsets;
-
-/**
- * SecureCharBufferPropertyValue uses {@link SecureCharBuffer}
- */
-public class SecureCharBufferPropertyValue implements PropertyValue {
- private final SecureCharBuffer value;
-
- /**
- * Builder for {@link SecureCharBufferPropertyValue}
- */
- static class Factory implements PropertyValue.Factory {
-
- @Override
- public PropertyValue of(CharSequence aString) {
- return new SecureCharBufferPropertyValue(aString);
- }
-
- @Override
- public PropertyValue of(char[] value) {
- return new SecureCharBufferPropertyValue(value);
- }
-
- @Override
- public PropertyValue of(byte[] value) {
- return new SecureCharBufferPropertyValue(value);
- }
- }
-
- public SecureCharBufferPropertyValue(CharSequence aString) {
- this.value = SecureCharBuffer.withCapacity(aString.length());
- this.value.append(aString);
- }
-
- public SecureCharBufferPropertyValue(char [] value) {
- this.value = SecureCharBuffer.withCapacity(value.length);
- this.value.append(CharBuffer.wrap(value));
- }
-
- public SecureCharBufferPropertyValue(byte [] value) {
- this.value = SecureCharBuffer.withCapacity(value.length);
- this.value.append(StandardCharsets.UTF_8.decode(ByteBuffer.wrap(value)));
- }
- @Override
- public String getValueAsString() {
- return this.value.toStringAble().toString();
- }
-
- @Override
- public CharSequence getValue() {
- return this.value;
- }
-
- @Override
- public char [] getValueAsChars() {
- return CharBuffer.wrap(value).array();
- }
-
- @Override
- public byte [] getValueAsBytes() {
- return StandardCharsets.UTF_8.encode(CharBuffer.wrap(value)).array();
- }
-
- @Override
- public boolean isProtected() {
- return true;
- }
-}
-
diff --git a/example/src/main/java/org/linguafranca/pwdb/kdbx/ChooseFile.java b/example/src/main/java/org/linguafranca/pwdb/kdbx/ChooseFile.java
index e0f4f266..3eb9a6e4 100644
--- a/example/src/main/java/org/linguafranca/pwdb/kdbx/ChooseFile.java
+++ b/example/src/main/java/org/linguafranca/pwdb/kdbx/ChooseFile.java
@@ -1,7 +1,25 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.kdbx;
-import com.google.common.base.Strings;
-import org.linguafranca.util.HexViewer;
+import org.linguafranca.pwdb.format.KdbxCredentials;
+import org.linguafranca.pwdb.format.KdbxHeader;
+import org.linguafranca.pwdb.format.KdbxSerializer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -12,15 +30,14 @@
import java.nio.file.Files;
import java.nio.file.Paths;
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
+import static org.linguafranca.pwdb.kdbx.jackson.util.Util.streamToString;
+
/**
* Utility to allow browsing of database files and listing content to console
*/
public class ChooseFile {
- OutputStream outputStream = getTestPrintStream();
-
public static void main(String[] args) throws IOException {
ChooseFile cf = new ChooseFile();
cf.choose();
@@ -63,13 +80,16 @@ public String getDescription() {
null,
null,
"123");
- if (Strings.isNullOrEmpty(s)) {
+ if (s==null || s.isEmpty()) {
return;
}
logger.info("Opening {}", fc.getSelectedFile().getPath());
- Util.listXml(fc.getSelectedFile().getName(),
- new KdbxCreds(s.getBytes()),
- new PrintWriter(outputStream));
+ try (InputStream is = Files.newInputStream(Paths.get(fc.getSelectedFile().getPath()))) {
+ InputStream ss = KdbxSerializer.createUnencryptedInputStream(new KdbxCredentials(s.getBytes()), new KdbxHeader(), is);
+ System.out.println(streamToString(ss));
+ System.out.println();
+ System.out.flush();
+ }
/* try (InputStream is = Files.newInputStream(Paths.get(fc.getSelectedFile().getPath()))) {
HexViewer.list(is);
}*/
diff --git a/example/src/main/java/org/linguafranca/pwdb/kdbx/Misc.java b/example/src/main/java/org/linguafranca/pwdb/kdbx/Misc.java
new file mode 100644
index 00000000..e1058435
--- /dev/null
+++ b/example/src/main/java/org/linguafranca/pwdb/kdbx/Misc.java
@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.linguafranca.pwdb.kdbx;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.PrintStream;
+
+import static org.linguafranca.util.TestUtil.getTestPrintStream;
+
+public class Misc {
+
+ /**
+ * Useful for e.g. viewing the raw file contents
+ */
+ public static class HexViewer {
+
+ static PrintStream printStream = getTestPrintStream();
+
+ public static void list(InputStream is) throws IOException {
+ for (int i = 0; i < 32; i++) {
+ byte[] buf = new byte [16];
+ is.read(buf);
+ StringBuilder sb = new StringBuilder();
+ for (byte b: buf) {
+ sb.append(String.format("%02X ", b));
+ }
+ sb.append(" ");
+ for (byte b : buf) {
+ sb.append(b < 0x20 || b > 0x7e ? (char) 0x00B7 : (char) b);
+ }
+ printStream.println(sb);
+ }
+ }
+ }
+
+
+
+}
diff --git a/example/src/main/java/org/linguafranca/pwdb/kdbx/OpenDbExample.java b/example/src/main/java/org/linguafranca/pwdb/kdbx/OpenDbExample.java
index 8af6c6f3..d268c6bb 100644
--- a/example/src/main/java/org/linguafranca/pwdb/kdbx/OpenDbExample.java
+++ b/example/src/main/java/org/linguafranca/pwdb/kdbx/OpenDbExample.java
@@ -1,11 +1,27 @@
+/*
+ * Copyright (c) 2025. Jo Rabin
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
package org.linguafranca.pwdb.kdbx;
import org.linguafranca.pwdb.Database;
+import org.linguafranca.pwdb.KdbConsts;
import org.linguafranca.pwdb.Visitor;
-import org.linguafranca.pwdb.kdbx.dom.DomDatabaseWrapper;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-import org.linguafranca.pwdb.kdbx.jaxb.JaxbDatabase;
-import org.linguafranca.pwdb.kdbx.simple.SimpleDatabase;
+import org.linguafranca.pwdb.format.KdbxCredentials;
+import org.linguafranca.pwdb.kdbx.jackson.KdbxDatabase;
import java.io.InputStream;
import java.io.PrintStream;
@@ -14,6 +30,9 @@
/**
* Example and naive speed test for various implementations.
+ *
+ * It was used to compare the various implementations of KDBX in V2. It isn't really very interesting in V3 but
+ * remains here in case new implementations are added.
*
* @author jo
*/
@@ -22,42 +41,21 @@ public class OpenDbExample {
static PrintStream printStream = getTestPrintStream();
private interface DbLoader {
- Database load(KdbxCreds creds, InputStream inputStream) throws Exception;
- }
-
- private static class SimpleDbLoader implements DbLoader {
- @Override
- public Database load(KdbxCreds creds, InputStream inputStream) throws Exception {
- return SimpleDatabase.load(creds, inputStream);
- }
- }
-
- private static class DomDbLoader implements DbLoader {
- @Override
- public Database load(KdbxCreds creds, InputStream inputStream) throws Exception {
- return DomDatabaseWrapper.load(creds, inputStream);
- }
- }
-
- private static class JaxbDbLoader implements DbLoader {
- @Override
- public Database load(KdbxCreds creds, InputStream inputStream) throws Exception {
- return JaxbDatabase.load(creds, inputStream);
- }
+ Database load(KdbxCredentials creds, InputStream inputStream) throws Exception;
}
- private static class JacksonDbLoader implements DbLoader {
+ private static class KdbxLoader implements DbLoader {
@Override
- public Database load(KdbxCreds creds, InputStream inputStream) throws Exception {
- return JacksonDatabase.load(creds, inputStream);
+ public Database load(KdbxCredentials creds, InputStream inputStream) throws Exception {
+ return KdbxDatabase.load(creds, inputStream);
}
}
- public static void testDb (DbLoader loader, String label, int loads, int iterations) throws Exception {
- KdbxCreds creds = new KdbxCreds("123".getBytes());
+ private static void testDb (DbLoader loader, String label, int loads, int iterations) throws Exception {
+ KdbxCredentials creds = new KdbxCredentials(KdbConsts.PASSWORD_BYTES);
long start = System.currentTimeMillis();
for (int i=0; i < loads; i++) {
- try (InputStream inputStream = OpenDbExample.class.getClassLoader().getResourceAsStream("test1.kdbx")) {
+ try (InputStream inputStream = OpenDbExample.class.getResourceAsStream("/test1.kdbx")) {
Database database = loader.load(creds, inputStream);
for (int j = 0; j < iterations; j++) {
database.visit(new Visitor.Default() {
@@ -71,36 +69,24 @@ public static void testDb (DbLoader loader, String label, int loads, int iterati
public static void main(String[] args) throws Exception {
printStream.println("Warming up JVM");
- testDb(new SimpleDbLoader(), "Simple", 5, 20);
- testDb(new JaxbDbLoader(), "Jaxb", 5, 20);
- testDb(new DomDbLoader(), "Dom", 5, 20);
- testDb(new JacksonDbLoader(), "Jackson", 5, 20);
+ testDb(new KdbxLoader(), "Jackson", 5, 20);
printStream.println("Sleeping");
System.gc();
Thread.sleep(2000);
- testDb(new SimpleDbLoader(), "Simple", 5, 20);
- testDb(new JaxbDbLoader(), "Jaxb", 5, 20);
- testDb(new DomDbLoader(), "Dom", 5, 20);
- testDb(new JacksonDbLoader(), "Jackson", 5, 20);
+ testDb(new KdbxLoader(), "Jackson", 5, 20);
printStream.println("Sleeping");
System.gc();
Thread.sleep(2000);
- testDb(new SimpleDbLoader(), "Simple", 10, 1);
- testDb(new JaxbDbLoader(), "Jaxb", 10, 1);
- testDb(new DomDbLoader(), "Dom", 10, 1);
- testDb(new JacksonDbLoader(), "Jackson", 10, 1);
+ testDb(new KdbxLoader(), "Jackson", 10, 1);
printStream.println("Sleeping");
System.gc();
Thread.sleep(2000);
- testDb(new SimpleDbLoader(), "Simple", 1, 50);
- testDb(new JaxbDbLoader(), "Jaxb", 1, 50);
- testDb(new DomDbLoader(), "Dom", 1, 50);
- testDb(new JacksonDbLoader(), "Jackson", 1, 50);
+ testDb(new KdbxLoader(), "Jackson", 1, 50);
}
}
diff --git a/example/src/main/java/org/linguafranca/pwdb/kdbx/QuickStart.java b/example/src/main/java/org/linguafranca/pwdb/kdbx/QuickStart.java
index c68a93b3..be04fb46 100644
--- a/example/src/main/java/org/linguafranca/pwdb/kdbx/QuickStart.java
+++ b/example/src/main/java/org/linguafranca/pwdb/kdbx/QuickStart.java
@@ -1,35 +1,41 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb.kdbx;
-import org.junit.BeforeClass;
import org.linguafranca.pwdb.*;
+import org.linguafranca.pwdb.format.KdbxCredentials;
+import org.linguafranca.pwdb.format.KdbxHeader;
+import org.linguafranca.pwdb.format.KdbxStreamFormat;
import org.linguafranca.pwdb.kdb.KdbCredentials;
import org.linguafranca.pwdb.kdb.KdbDatabase;
-import org.linguafranca.pwdb.kdbx.dom.DomDatabaseWrapper;
+import org.linguafranca.pwdb.kdbx.jackson.KdbxDatabase;
import org.linguafranca.pwdb.security.Encryption;
+import org.linguafranca.util.TestUtil;
import java.io.*;
import java.nio.file.Files;
-import java.nio.file.Paths;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
import java.util.List;
+import java.util.Objects;
-import static org.junit.Assert.assertEquals;
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
+import static java.nio.file.StandardOpenOption.*;
+import static org.linguafranca.pwdb.Entry.STANDARD_PROPERTY_NAME.*;
/**
* Examples for QuickStart
@@ -37,80 +43,128 @@
* @author jo
*/
@SuppressWarnings("WeakerAccess")
-public abstract class QuickStart, G extends Group, E extends Entry, I extends Icon> {
+public final class QuickStart {
+
+ public static void canonicalQuickStart(Path tempPath) throws IOException {
- static PrintStream printStream = getTestPrintStream();
+ // V3 create a database, no need to specify what kind (e.g. JacksonDatabase)
+ // V3 Database no longer need to be generified
+ Database database = new KdbxDatabase();
+ // V3 the property value strategy is set to PropertyValue.Strategy.Default(), anyway, but the Default property
+ // value strategy being to protect field "Password" and no other, all of which are stored as byte[]
+ database.setPropertyValueStrategy(new PropertyValue.Strategy.Default());
+ // V3 Group is not generified. create a group
+ // V3 short-cut add a new group to another group with the name supplied
+ Group main = database.getRootGroup().addGroup("Main");
+ // V3 fluent building of Entry (using PropertyValueStrategy as set in database to determine protection)
+ main.addEntry()
+ // V3 addProperty short-cut for setPropertyValue
+ // V3 abbreviated static import of standard field names
+ .addProperty(TITLE, "first entry")
+ .addProperty(USER_NAME, "Tom")
+ .addProperty(PASSWORD, KdbConsts.PASSWORD_BYTES)
+ .addProperty(URL, "http://localhost:8080/")
+ .addEntry("2nd Entry") // v3 addEntry on Entry adds Entry to parent Group if exists
+ .addProperty(USER_NAME, "Alice")
+ .addProperty(PASSWORD, KdbConsts.PASSWORD_BYTES);
+ // find entries just added, in V3 the findEntries return value is just List
+ List entries = database.findEntries("entry");
+
+ // V3 KdbxCreds now called KdbxCredentials
+ KdbxCredentials credentials = new KdbxCredentials(KdbConsts.PASSWORD_BYTES);
+ try (OutputStream outputStream = Files.newOutputStream(tempPath.resolve("test.kdbx"))) {
+ database.save(credentials, outputStream);
+ }
+ }
- public abstract D getDatabase();
- public abstract D loadDatabase(Credentials creds, InputStream inputStream);
+ /**
+ * Illustrates the fluent API for creating a database, as well as the various ways of setting property values.
+ */
+ public static void fluentExample() {
+ Database database = new KdbxDatabase();
+ database.getRootGroup().addGroup("Group 1")
+ .addEntry("as property values determined by the database property value strategy (preferred)")
+ .addProperty("prop1", "value1".getBytes())
+ .addProperty("prop2", "value2")
+ .addProperty("prop3", "value3")
+ .addEntry("as non default storage type (according to PropertyValueStrategy) property values")
+ .setPropertyValue("prop1", database.getPropertyValueStrategy().newProtected().of("value1"))
+ .setPropertyValue("prop2", database.getPropertyValueStrategy().newUnprotected().of("value2"))
+ .addEntry("as explicit storage type property values")
+ .setPropertyValue("prop1", new PropertyValue.BytesStore("value1".getBytes()))
+ .setPropertyValue("prop2", new PropertyValue.SealedStore("value2"))
+ .addEntry("as strings")
+ .setProperty("prop1", "value1")
+ .setProperty("prop2", "value2")
+ .setProperty("prop3", "value3");
- @BeforeClass
- public static void ensureOutputDir() throws IOException {
- Files.createDirectories(Paths.get("testOutput"));
+ // find entries just added, in V3 the findEntries return value is just List
+ List entries = database.findEntries("prop");
}
/**
- * Load KDBX
+ * Load KDBX from file
*/
- public void loadKdbx() throws IOException {
+ public static void loadKdbx() throws IOException {
// get an input stream
- try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream("test123.kdbx")) {
+ try (InputStream inputStream = QuickStart.class.getResourceAsStream("/test123.kdbx")) {
// password credentials
- Credentials credentials = new KdbxCreds("123".getBytes());
- // Jaxb implementation seems a lot faster than the DOM implementation
- D database = loadDatabase(credentials, inputStream);
+ Credentials credentials = new KdbxCredentials(KdbConsts.PASSWORD_BYTES);
+ // load the database from the input stream
+ Database database = KdbxDatabase.load(credentials, Objects.requireNonNull(inputStream));
// visit all groups and entries and list them to console
- database.visit(new Visitor.Print(printStream));
+ database.visit(new Visitor.Print(System.out));
}
}
/**
- * Save KDBX
+ * Save KDBX to file
*/
- private E entryFactory(D database, String s, int e) {
+ private static Entry entryFactory(Database database, String s, int e) {
return database.newEntry(String.format("Group %s Entry %d", s, e));
}
- public void saveKdbx() throws IOException {
+ public static void saveKdbx(Path tempPath) throws IOException {
// create an empty database
- D database = getDatabase();
+ Database database = new KdbxDatabase();
// add some groups and entries
- for (Integer g = 0; g < 5; g++) {
- G group = database.getRootGroup().addGroup(database.newGroup(g.toString()));
+ for (int g = 0; g < 5; g++) {
+ Group group = database.getRootGroup().addGroup(database.newGroup(Integer.toString(g)));
for (int e = 0; e <= g; e++) {
// entry factory is a local helper to populate an entry
- group.addEntry(entryFactory(database, g.toString(), e));
+ group.addEntry(entryFactory(database, Integer.toString(g), e));
}
}
// save to a file with password "123"
- try (FileOutputStream outputStream = new FileOutputStream("testOutput/test.kdbx")) {
- database.save(new KdbxCreds("123".getBytes()), outputStream);
+ try (OutputStream outputStream = Files.newOutputStream(tempPath.resolve( "test.kdbx"))) {
+ database.save(new KdbxCredentials(KdbConsts.PASSWORD_BYTES), outputStream);
}
}
/**
* Splice - add a group from one database to a parent from another (or copy from the same db)
*/
- public void splice(G newParent, Group groupToSplice) {
- G addedGroup = newParent.addGroup(newParent.getDatabase().newGroup(groupToSplice));
+ public static void splice(Group newParent, Group groupToSplice) {
+ Group addedGroup = newParent.addGroup(newParent.getDatabase().newGroup(groupToSplice));
addedGroup.copy(groupToSplice);
}
/**
* Group by title
*/
- public G groupByTitle(D database) {
- List entries = database.findEntries(entry -> entry.getProperty(Entry.STANDARD_PROPERTY_NAME_TITLE).toLowerCase().contains("findme!"));
+ public static Group groupByTitle(Database database) {
+ List entries =
+ database.findEntries(entry -> entry.getProperty(Entry.STANDARD_PROPERTY_NAME_TITLE).toLowerCase().contains("findme!"));
// create a new group using DB factory method
- G newParent = database.newGroup("Found entries");
+ Group newParent = database.newGroup("Found entries");
// iterate over the found entries
- for (E entry : entries) {
+ for (Entry entry : entries) {
// copy the entry using DB factory so that it remains where it was found as well as being in new group
- E copy = database.newEntry(entry);
+ Entry copy = database.newEntry(entry);
// add new entry to new group
newParent.addEntry(copy);
}
@@ -120,82 +174,102 @@ public G groupByTitle(D database) {
/**
* Load KDB and save as KDBX
*/
- public void loadKdb() throws IOException {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("test123.kdb");
- // password credentials
- Credentials credentials = new KdbCredentials.Password("123".getBytes());
- // load KdbDatabase
- KdbDatabase database = KdbDatabase.load(credentials, inputStream);
- // visit all groups and entries and list them to console
+ public static void loadKdbSaveKdbx(Path tempPath) throws IOException {
+ KdbDatabase database;
+ try (InputStream inputStream = QuickStart.class.getResourceAsStream("/test123.kdb")) {
+ // password credentials
+ Credentials credentials = new KdbCredentials.Password(KdbConsts.PASSWORD_BYTES);
+ // load KdbDatabase
+ database = KdbDatabase.load(credentials, Objects.requireNonNull(inputStream));
+ }
// create a KDBX (database
- D kdbxDatabase = getDatabase();
+ Database kdbxDatabase = new KdbxDatabase();
kdbxDatabase.setName("New Database");
kdbxDatabase.setDescription("Migration of KDB Database to KDBX Database");
// deep copy from group (not including source group, KDB database has simulated root)
kdbxDatabase.getRootGroup().copy(database.getRootGroup());
// save it
- try (FileOutputStream f = new FileOutputStream("testOutput/migration.kdbx")) {
- kdbxDatabase.save(new KdbxCreds("123".getBytes()), f);
+ try (OutputStream f = Files.newOutputStream(tempPath.resolve( "migration.kdbx"))) {
+ kdbxDatabase.save(new KdbxCredentials(KdbConsts.PASSWORD_BYTES), f);
}
}
/**
* Load KDBX V3 save as KDBX V4
*/
- public void loadKdbx3SaveKdbx4(String resourceName, byte[] password, OutputStream v4OutputStream) throws IOException {
- DomDatabaseWrapper database;
+ public static void loadKdbx3SaveKdbx4(String v3ResourceName, byte[] password, Path v4Filename) throws IOException {
+ KdbxDatabase database;
// password credentials
- KdbxCreds credentials = new KdbxCreds(password);
- try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(resourceName)) {
+ KdbxCredentials credentials = new KdbxCredentials(password);
+ try (InputStream inputStream = QuickStart.class.getResourceAsStream(v3ResourceName)) {
// load KdbDatabase
- database = DomDatabaseWrapper.load(credentials, inputStream);
+ database = KdbxDatabase.load(credentials, Objects.requireNonNull(inputStream));
}
// create a KDBX (database
- D kdbxDatabase = getDatabase();
+ Database kdbxDatabase = new KdbxDatabase();
kdbxDatabase.setName("New Database");
kdbxDatabase.setDescription("Migration of KDBX 3 Database to KDBX 4 Database");
- // deep copy from group (not including source group, KDB database has simulated root)
+ // deep copy from group (not including source group)
kdbxDatabase.getRootGroup().copy(database.getRootGroup());
// choose a stream format - V4 Kdbx and choose some algorithms
KdbxHeader kdbxHeader = new KdbxHeader(KdbxHeader.KdbxHeaderOpts.V4_AES_ARGON_CHA_CHA);
- KdbxStreamFormat formatV4 = new KdbxStreamFormat(kdbxHeader);
// change algorithm from those originally selected
kdbxHeader.setCipherAlgorithm(Encryption.Cipher.CHA_CHA_20);
kdbxHeader.setKeyDerivationFunction(Encryption.KeyDerivationFunction.ARGON2);
kdbxHeader.setProtectedStreamAlgorithm(Encryption.ProtectedStreamAlgorithm.CHA_CHA_20);
+ KdbxStreamFormat formatV4 = new KdbxStreamFormat(kdbxHeader);
+
// save it with format options
- kdbxDatabase.save(formatV4, credentials, v4OutputStream);
+ try (OutputStream v4OutputStream = Files.newOutputStream(v4Filename, CREATE_NEW, SYNC)) {
+ kdbxDatabase.save(formatV4, credentials, v4OutputStream);
+ }
}
-
/**
* Load KDBX V3 save as KDBX V4
*/
- public void loadKdbx4SaveKdbx3(String resourceName, byte[] password, OutputStream v3OutputStream) throws IOException {
- DomDatabaseWrapper database;
+ public static void loadKdbx4SaveKdbx3(String resourceName, byte[] password, Path v3Filename) throws IOException {
+ KdbxDatabase database;
// password credentials
- KdbxCreds credentials = new KdbxCreds(password);
- try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(resourceName)) {
+ KdbxCredentials credentials = new KdbxCredentials(password);
+ try (InputStream inputStream = QuickStart.class.getResourceAsStream(resourceName)) {
// load KdbDatabase
- database = DomDatabaseWrapper.load(credentials, inputStream);
+ database = KdbxDatabase.load(credentials, Objects.requireNonNull(inputStream));
}
- // create a KDBX (database
- D kdbxDatabase = getDatabase();
+ // create a KDBX database
+ Database kdbxDatabase = new KdbxDatabase();
kdbxDatabase.setName("New Database");
kdbxDatabase.setDescription("Migration of KDBX 4 Database to KDBX 3 Database");
- // deep copy from group (not including source group, KDB database has simulated root)
+ // deep copy from group (not including source group
kdbxDatabase.getRootGroup().copy(database.getRootGroup());
- // choose a stream format - V4 Kdbx and choose some algorithms
+ // choose a stream format - V3
KdbxHeader kdbxHeader = new KdbxHeader(KdbxHeader.KdbxHeaderOpts.V3_AES_SALSA_20);
KdbxStreamFormat formatV3 = new KdbxStreamFormat(kdbxHeader);
// save it with format options
- kdbxDatabase.save(formatV3, credentials, v3OutputStream);
+ try (OutputStream v3OutputStream = Files.newOutputStream(v3Filename)) {
+ kdbxDatabase.save(formatV3, credentials, v3OutputStream);
+ }
+ }
+
+ /**
+ * Load KDBX V3 save as KDBX V4
+ */
+ public static void loadKdbx4SaveToConsole(String resourceName, byte[] password, Path path) throws IOException {
+ KdbxDatabase database;
+ // password credentials
+ KdbxCredentials credentials = new KdbxCredentials(password);
+ try (InputStream inputStream = QuickStart.class.getResourceAsStream(resourceName)) {
+ // load KdbDatabase
+ database = KdbxDatabase.load(credentials, Objects.requireNonNull(inputStream));
+ }
+
+ database.save(new StreamFormat.None(), new Credentials.None(), TestUtil.getTestPrintStream());
}
}
diff --git a/example/src/main/java/org/linguafranca/pwdb/kdbx/SaxParse.java b/example/src/main/java/org/linguafranca/pwdb/kdbx/SaxParse.java
index 2128b9d2..864b0dd0 100644
--- a/example/src/main/java/org/linguafranca/pwdb/kdbx/SaxParse.java
+++ b/example/src/main/java/org/linguafranca/pwdb/kdbx/SaxParse.java
@@ -1,22 +1,26 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb.kdbx;
import org.linguafranca.pwdb.Credentials;
+import org.linguafranca.pwdb.format.Helpers;
+import org.linguafranca.pwdb.format.KdbxHeader;
+import org.linguafranca.pwdb.format.KdbxSerializer;
import org.linguafranca.pwdb.security.StreamEncryptor;
import org.xml.sax.*;
import org.xml.sax.helpers.DefaultHandler;
@@ -29,6 +33,12 @@
import java.io.PrintWriter;
/**
+ * NB if you want to examine the XML of a KeePass file it's easiest to use
+ *
+ * database.save(new KdbxFormat.None(), new Credentials.None(), new PrintWriter(System.out));
+ *
+ *
+ * See {@link QuickStart#loadKdbx4SaveToConsole}
* @author jo
*/
public class SaxParse {
@@ -89,5 +99,6 @@ public void characters(char[] ch, int start, int length) {
InputSource xmlInputSource = new InputSource(decryptedInputStream);
xmlReader.parse(xmlInputSource);
}
+ writer.flush();
}
}
diff --git a/example/src/test/java/org/linguafranca/pwdb/kdbx/SaxParseTest.java b/example/src/test/java/org/linguafranca/pwdb/kdbx/SaxParseTest.java
index 1d673046..f9c98e19 100644
--- a/example/src/test/java/org/linguafranca/pwdb/kdbx/SaxParseTest.java
+++ b/example/src/test/java/org/linguafranca/pwdb/kdbx/SaxParseTest.java
@@ -1,22 +1,26 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb.kdbx;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.parallel.Execution;
+import org.linguafranca.pwdb.KdbConsts;
+import org.linguafranca.pwdb.format.KdbxCredentials;
import org.xml.sax.SAXException;
import javax.xml.parsers.ParserConfigurationException;
@@ -24,22 +28,23 @@
import java.io.OutputStream;
import java.io.PrintWriter;
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
import static org.linguafranca.util.TestUtil.getTestPrintStream;
/**
* @author jo
*/
-
+@Execution(CONCURRENT)
public class SaxParseTest extends SaxParse {
- OutputStream outputStream = getTestPrintStream();
@Test
public void exampleSaxParsingV3 () throws IOException, SAXException, ParserConfigurationException {
- super.exampleSaxParsing("test123.kdbx", new KdbxCreds("123".getBytes()), new PrintWriter(outputStream));
+ super.exampleSaxParsing("test123.kdbx", new KdbxCredentials(KdbConsts.PASSWORD_BYTES), new PrintWriter(System.out));
}
+
@Test
public void exampleSaxParsingV4 () throws IOException, SAXException, ParserConfigurationException {
- super.exampleSaxParsing("V4-AES-AES.kdbx", new KdbxCreds("123".getBytes()), new PrintWriter(outputStream));
+ super.exampleSaxParsing("V4-AES-AES.kdbx", new KdbxCredentials(KdbConsts.PASSWORD_BYTES), new PrintWriter(System.out));
}
}
diff --git a/example/src/test/java/org/linguafranca/pwdb/kdbx/SimpleQuickStartTest.java b/example/src/test/java/org/linguafranca/pwdb/kdbx/SimpleQuickStartTest.java
index f9c8a71f..3e730e92 100644
--- a/example/src/test/java/org/linguafranca/pwdb/kdbx/SimpleQuickStartTest.java
+++ b/example/src/test/java/org/linguafranca/pwdb/kdbx/SimpleQuickStartTest.java
@@ -1,96 +1,110 @@
/*
- * Copyright 2015 Jo Rabin
+ * Copyright (c) 2025. Jo Rabin
+ * Copyright (c) 2025. Sergio Lissner
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
+ *
*/
package org.linguafranca.pwdb.kdbx;
-import org.junit.Test;
-import org.linguafranca.pwdb.Credentials;
-import org.linguafranca.pwdb.kdbx.dom.DomDatabaseWrapper;
-import org.linguafranca.pwdb.kdbx.dom.DomEntryWrapper;
-import org.linguafranca.pwdb.kdbx.dom.DomGroupWrapper;
-import org.linguafranca.pwdb.kdbx.dom.DomIconWrapper;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.api.parallel.Execution;
+import org.linguafranca.pwdb.KdbConsts;
+import org.linguafranca.pwdb.format.KdbxCredentials;
+import org.linguafranca.pwdb.format.KdbxStreamFormat;
+import org.linguafranca.pwdb.kdbx.jackson.KdbxDatabase;
import org.linguafranca.pwdb.security.Encryption;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
-import java.nio.file.Paths;
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.parallel.ExecutionMode.CONCURRENT;
+import static org.linguafranca.pwdb.kdbx.QuickStart.*;
/**
* Simple illustration of hooking a SAX parser up to process a KDBX file
*
* @author jo
*/
-public class SimpleQuickStartTest extends QuickStart {
-
+@Execution(CONCURRENT)
+public class SimpleQuickStartTest {
- @Override
- public DomDatabaseWrapper getDatabase() {
- return new DomDatabaseWrapper();
+ @Test
+ public void canonicalQuickstartTest(@TempDir Path tempPath) throws IOException {
+ canonicalQuickStart(tempPath);
}
- @Override
- public DomDatabaseWrapper loadDatabase(Credentials credentials, InputStream inputStream){
- try {
- return DomDatabaseWrapper.load(credentials, inputStream);
- } catch (Exception e) {
- throw new IllegalStateException(e);
- }
+ @Test
+ public void fluentExampleTest() {
+ fluentExample();
}
@Test
- public void saveTest() throws IOException {
- super.saveKdbx();
+ public void saveTest(@TempDir Path tempPath) throws IOException {
+ saveKdbx(tempPath);
}
@Test
public void loadTest() throws IOException {
- super.loadKdbx();
+ QuickStart.loadKdbx();
}
@Test
- public void loadKdbSaveVernacular() throws IOException {
- super.loadKdb();
+ public void loadKdbSaveKdbx(@TempDir Path tempPath) throws IOException {
+ QuickStart.loadKdbSaveKdbx(tempPath);
}
@Test
- public void loadSave() throws IOException {
- Path path = Paths.get("testOutput/CHACHA-AES-CHACHA.kdbx");
+ public void loadSave(@TempDir Path tempPath) throws IOException {
+ Path actualTempPath = Files.createTempDirectory("kbdx-");
+ System.out.println("actualTempPath: " + actualTempPath.toAbsolutePath());
+ Path path = actualTempPath.resolve("CHACHA-AES-CHACHA.kdbx");
- loadKdbx3SaveKdbx4("test123.kdbx","123".getBytes(), Files.newOutputStream(path));
+ QuickStart.loadKdbx3SaveKdbx4("/test123.kdbx", KdbConsts.PASSWORD_BYTES, path);
// load newly created V4 database
- DomDatabaseWrapper db = DomDatabaseWrapper.load(new KdbxCreds("123".getBytes()), Files.newInputStream(path));
+ KdbxDatabase db;
+ try (InputStream inputStream = Files.newInputStream(path)) {
+ db = KdbxDatabase.load(new KdbxCredentials(KdbConsts.PASSWORD_BYTES), inputStream);
+ }
+ catch (Throwable t) {
+ System.out.println(path.toAbsolutePath());
+ int _=0;
+ throw new RuntimeException(t);
+ }
KdbxStreamFormat streamFormat = (KdbxStreamFormat) db.getStreamFormat();
assertEquals(4, streamFormat.getStreamConfiguration().getVersion());
assertEquals(Encryption.Cipher.CHA_CHA_20, streamFormat.getStreamConfiguration().getCipherAlgorithm());
assertEquals(Encryption.KeyDerivationFunction.ARGON2, streamFormat.getStreamConfiguration().getKeyDerivationFunction());
assertEquals(Encryption.ProtectedStreamAlgorithm.CHA_CHA_20, streamFormat.getStreamConfiguration().getProtectedStreamAlgorithm());
}
+
@Test
- public void loadSave2() throws IOException {
- Path path = Paths.get("testOutput/CHACHA-AES-CHACHA.kdbx");
+ public void loadSave2(@TempDir Path tempPath) throws IOException {
+ Path path = tempPath.resolve("CHACHA-AES-CHACHA.kdbx");
- loadKdbx4SaveKdbx3("V4-ChaCha20-Argon2-Attachment.kdbx","123".getBytes(), Files.newOutputStream(path));
+ QuickStart.loadKdbx4SaveKdbx3("/V4-ChaCha20-Argon2-Attachment.kdbx", KdbConsts.PASSWORD_BYTES, path);
// load newly created V4 database
- DomDatabaseWrapper db = DomDatabaseWrapper.load(new KdbxCreds("123".getBytes()), Files.newInputStream(path));
+ KdbxDatabase db;
+ try (InputStream inputStream = Files.newInputStream(path)) {
+ db = KdbxDatabase.load(new KdbxCredentials(KdbConsts.PASSWORD_BYTES), inputStream);
+ }
KdbxStreamFormat streamFormat = (KdbxStreamFormat) db.getStreamFormat();
assertEquals(3, streamFormat.getStreamConfiguration().getVersion());
assertEquals(Encryption.Cipher.AES, streamFormat.getStreamConfiguration().getCipherAlgorithm());
diff --git a/example/src/test/java/org/linguafranca/pwdb/kdbx/UtilTest.java b/example/src/test/java/org/linguafranca/pwdb/kdbx/UtilTest.java
deleted file mode 100644
index bfda2c5b..00000000
--- a/example/src/test/java/org/linguafranca/pwdb/kdbx/UtilTest.java
+++ /dev/null
@@ -1,47 +0,0 @@
-package org.linguafranca.pwdb.kdbx;
-
-import org.junit.Test;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.io.PrintWriter;
-
-import static org.linguafranca.pwdb.kdbx.Util.*;
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-public class UtilTest {
-
- OutputStream outputStream = getTestPrintStream();
- @Test public void listDatabaseTest() throws IOException {
- listDatabase("V3-CustomIcon.kdbx", new KdbxCreds("123".getBytes()), outputStream);
- }
-
- @Test
- public void listXmlTest() throws IOException {
- PrintWriter writer = new PrintWriter(outputStream);
- listXml("V3-CustomIcon.kdbx", new KdbxCreds("123".getBytes()), writer);
- writer.flush();
- }
-
- /**
- * List Database Encryption Characteristics
- */
- @Test
- public void listKdbxHeaderParams () throws IOException {
- PrintWriter writer = new PrintWriter(outputStream);
- listKdbxHeaderProperties("test123.kdbx", writer);
- listKdbxHeaderProperties("V4-AES-AES.kdbx", writer);
- listKdbxHeaderProperties("V4-AES-Argon2.kdbx", writer);
- listKdbxHeaderProperties("V4-ChaCha20-AES.kdbx", writer);
- listKdbxHeaderProperties("V4-ChaCha20-Argon2-Attachment.kdbx", writer);
- writer.flush();
- }
-
- @Test
- public void listHeaderPropertiesAndXml() throws IOException {
- PrintWriter writer = new PrintWriter(outputStream);
- listKdbxHeaderProperties("V4-AES-Argon2-CustomIcon.kdbx", writer);
- listXml("V4-AES-Argon2-CustomIcon.kdbx", new KdbxCreds("123".getBytes()), writer);
- writer.flush();
- }
-}
diff --git a/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue27Test.java b/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue27Test.java
deleted file mode 100644
index be04ad11..00000000
--- a/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue27Test.java
+++ /dev/null
@@ -1,65 +0,0 @@
-package org.linguafranca.pwdb.kdbx.validation;
-
-import com.google.common.io.CharStreams;
-import org.junit.Ignore;
-import org.junit.Test;
-import org.linguafranca.pwdb.kdbx.Helpers;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.KdbxHeader;
-import org.linguafranca.pwdb.kdbx.KdbxSerializer;
-import org.linguafranca.pwdb.kdbx.jaxb.JaxbDatabase;
-import org.linguafranca.pwdb.kdbx.jaxb.JaxbEntry;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.PrintStream;
-import java.nio.charset.StandardCharsets;
-import java.util.List;
-
-import static org.junit.Assert.assertEquals;
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-public class Issue27Test {
- static PrintStream printStream = getTestPrintStream();
- /**
- * Check load of problem file
- */
- @Test
- public void testIssue27() throws IOException {
- InputStream is = this.getClass().getClassLoader().getResourceAsStream("issue-27/bogus-timestamp2.kdbx");
- KdbxCreds creds = new KdbxCreds("passwordless".getBytes());
- JaxbDatabase db = JaxbDatabase.load(creds, is);
- List entries = db.findEntries("testtitle");
-
- for (JaxbEntry entry: entries) {
- printStream.println(Helpers.fromDateV3(entry.getCreationTime()));
- assertEquals("2021-01-11T09:18:56Z", Helpers.fromDateV3(entry.getCreationTime()));
- }
- }
-
- /**
- * Verify that V4 dates are still processed correctly
- */
- @Test
- public void testV4Date() throws IOException {
- InputStream is = this.getClass().getClassLoader().getResourceAsStream("V4-AES-AES.kdbx");
- KdbxCreds creds = new KdbxCreds("123".getBytes());
- JaxbDatabase db = JaxbDatabase.load(creds, is);
- List entries = db.findEntries("Sample Entry #2 - Copy");
-
- for (JaxbEntry entry: entries) {
- printStream.println(Helpers.fromDate(entry.getCreationTime()));
- assertEquals("2018-01-26T13:20:58Z", Helpers.fromDateV3(entry.getCreationTime()));
- }
- }
-
- @Test @Ignore
- public void testIssue27XML() throws IOException {
-
- InputStream is = this.getClass().getClassLoader().getResourceAsStream("issue-27/bogus-timestamp2.kdbx");
- KdbxCreds creds = new KdbxCreds("passwordless".getBytes());
- InputStream plainText = KdbxSerializer.createUnencryptedInputStream(creds,new KdbxHeader(), is);
- printStream.println(CharStreams.toString(new InputStreamReader(plainText, StandardCharsets.UTF_8)));
- }
-}
diff --git a/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue33Test.java b/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue33Test.java
deleted file mode 100644
index 322ee10a..00000000
--- a/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue33Test.java
+++ /dev/null
@@ -1,69 +0,0 @@
-package org.linguafranca.pwdb.kdbx.validation;
-
-
-import org.junit.Before;
-import org.junit.BeforeClass;
-import org.junit.Test;
-import org.linguafranca.pwdb.Credentials;
-import org.linguafranca.pwdb.StreamFormat;
-import org.linguafranca.pwdb.kdbx.Helpers;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.Util;
-import org.linguafranca.pwdb.kdbx.dom.DomDatabaseWrapper;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-import org.linguafranca.pwdb.kdbx.jaxb.JaxbDatabase;
-import org.linguafranca.pwdb.kdbx.simple.SimpleDatabase;
-
-import java.io.*;
-import java.nio.file.Files;
-import java.nio.file.Paths;
-
-/**
- * Review Issue-33 https://github.com/jorabin/KeePassJava2/issues/33
- */
-public class Issue33Test {
-
- public static final String TEST_RESOURCE = "V4-AES-Argon2-CustomIcon.kdbx";
- public static final String TEST_OUTPUT_DIR = "testOutput";
- public static final File TEST_XML_FILE = Paths.get(TEST_OUTPUT_DIR,"Issue33Source.xml").toFile();
- public static final KdbxCreds CREDENTIALS = new KdbxCreds("123".getBytes());
-
-
- InputStream inputStream;
-
- @BeforeClass
- public static void listXml() throws IOException {
- Files.createDirectories(Paths.get(TEST_OUTPUT_DIR));
- Util.listXml(TEST_RESOURCE, CREDENTIALS, new PrintWriter(TEST_XML_FILE));
- Helpers.isV4.set(true);
- }
-
- @Before
- public void refreshInputStream() {
- inputStream = this.getClass().getClassLoader().getResourceAsStream(TEST_RESOURCE);
- }
-
- @Test
- public void testDomDatabaseWrapper() throws IOException {
- DomDatabaseWrapper database = DomDatabaseWrapper.load(CREDENTIALS, inputStream);
- database.save(new StreamFormat.None(), new Credentials.None(), Files.newOutputStream(Paths.get(TEST_OUTPUT_DIR, "Issue33Dom.xml")));
- }
-
- @Test
- public void testJaxbDatabase() throws IOException {
- JaxbDatabase database = JaxbDatabase.load(CREDENTIALS, inputStream);
- database.save(new StreamFormat.None(), new Credentials.None(), Files.newOutputStream(Paths.get(TEST_OUTPUT_DIR, "Issue33Jaxb.xml")));
- }
-
- @Test
- public void testSimpleDatabase() throws IOException {
- SimpleDatabase database = SimpleDatabase.load(CREDENTIALS, inputStream);
- database.save(new StreamFormat.None(), new Credentials.None(), Files.newOutputStream(Paths.get(TEST_OUTPUT_DIR, "Issue33Simple.xml")));
- }
-
- @Test
- public void testJacksonDatabase() throws IOException {
- JacksonDatabase database = JacksonDatabase.load(CREDENTIALS, inputStream);
- database.save(new StreamFormat.None(), new Credentials.None(), Files.newOutputStream(Paths.get(TEST_OUTPUT_DIR, "Issue33Jackson.xml")));
- }
-}
diff --git a/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue38Test.java b/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue38Test.java
deleted file mode 100644
index 4684a712..00000000
--- a/example/src/test/java/org/linguafranca/pwdb/kdbx/validation/Issue38Test.java
+++ /dev/null
@@ -1,33 +0,0 @@
-package org.linguafranca.pwdb.kdbx.validation;
-
-import org.junit.Test;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.dom.DomDatabaseWrapper;
-import org.linguafranca.pwdb.kdbx.dom.DomEntryWrapper;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.PrintStream;
-import java.util.List;
-
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-/**
- * Bug report on GitHub, the Keyfile is Version 2 (Hex)
- */
-public class Issue38Test {
-
- static PrintStream printStream = getTestPrintStream();
- @Test
- public void testV2Keyfile() throws IOException {
- InputStream databaseStream = Issue38Test.class.getClassLoader().getResourceAsStream("issue-38/Database/Database.kdbx");
- InputStream keyStream = Issue38Test.class.getClassLoader().getResourceAsStream("issue-38/Database/Database.keyx");
- assert keyStream != null;
- KdbxCreds creds = new KdbxCreds("MyPassword".getBytes(), keyStream);
- assert databaseStream != null;
- DomDatabaseWrapper database = DomDatabaseWrapper.load(creds, databaseStream);
- List entries = database.findEntries("Sample Entry");
- DomEntryWrapper entry = entries.get(0);
- printStream.println(entry.getTitle());
- }
-}
diff --git a/test/src/main/resources/V4-AES-AES.kdbx b/example/src/test/resources/V4-AES-AES.kdbx
similarity index 100%
rename from test/src/main/resources/V4-AES-AES.kdbx
rename to example/src/test/resources/V4-AES-AES.kdbx
diff --git a/test/src/main/resources/V4-ChaCha20-Argon2-Attachment.kdbx b/example/src/test/resources/V4-ChaCha20-Argon2-Attachment.kdbx
similarity index 100%
rename from test/src/main/resources/V4-ChaCha20-Argon2-Attachment.kdbx
rename to example/src/test/resources/V4-ChaCha20-Argon2-Attachment.kdbx
diff --git a/test/src/main/resources/test1.kdbx b/example/src/test/resources/test1.kdbx
similarity index 100%
rename from test/src/main/resources/test1.kdbx
rename to example/src/test/resources/test1.kdbx
diff --git a/test/src/main/resources/test123.kdb b/example/src/test/resources/test123.kdb
similarity index 100%
rename from test/src/main/resources/test123.kdb
rename to example/src/test/resources/test123.kdb
diff --git a/test/src/main/resources/test123.kdbx b/example/src/test/resources/test123.kdbx
similarity index 100%
rename from test/src/main/resources/test123.kdbx
rename to example/src/test/resources/test123.kdbx
diff --git a/jackson/pom.xml b/jackson/pom.xml
deleted file mode 100644
index 9726b910..00000000
--- a/jackson/pom.xml
+++ /dev/null
@@ -1,53 +0,0 @@
-
-
-
-
- KeePassJava2-parent
- org.linguafranca.pwdb
- 2.2.3-SNAPSHOT
- ../pom.xml
-
- 4.0.0
-
- KeePassJava2-jackson
- KeePassJava2 :: Jackson
- Contains a Jackson XML implementation for KDBX.
-
-
-
- org.linguafranca.pwdb
- KeePassJava2-kdbx
- ${project.version}
-
-
- com.fasterxml.jackson.dataformat
- jackson-dataformat-xml
- 2.17.1
-
-
- com.fasterxml.woodstox
- woodstox-core
- 7.0.0
-
-
- org.linguafranca.pwdb
- test
- ${project.version}
- test
-
-
-
diff --git a/jackson/src/test/java/org/linguafranca/pwdb/JacksonBinaryPropertyV3Test.java b/jackson/src/test/java/org/linguafranca/pwdb/JacksonBinaryPropertyV3Test.java
deleted file mode 100644
index 41c14567..00000000
--- a/jackson/src/test/java/org/linguafranca/pwdb/JacksonBinaryPropertyV3Test.java
+++ /dev/null
@@ -1,66 +0,0 @@
-/*
- * Copyright 2023 Giuseppe Valente
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.linguafranca.pwdb;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-
-import org.linguafranca.pwdb.checks.BinaryPropertyChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-
-public class JacksonBinaryPropertyV3Test extends BinaryPropertyChecks {
-
-
- public JacksonBinaryPropertyV3Test() {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("Attachment.kdbx");
- try {
- database = JacksonDatabase.load(new KdbxCreds("123".getBytes()),inputStream);
- } catch (Exception e) {
- throw new IllegalStateException(e);
- }
- }
-
- @Override
- public void saveDatabase(Database database, Credentials credentials, OutputStream outputStream) throws IOException {
- database.save(credentials, outputStream);
- }
-
- @Override
- public Database loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- return JacksonDatabase.load(credentials, inputStream);
- }
-
- @Override
- public Database newDatabase() {
- Database result = null;
- try {
- result = new JacksonDatabase();
- } catch(Exception e) {
- throw new RuntimeException(e);
- }
- return result;
-
- }
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds(creds);
- }
-
-}
diff --git a/jackson/src/test/java/org/linguafranca/pwdb/JacksonBinaryPropertyV4Test.java b/jackson/src/test/java/org/linguafranca/pwdb/JacksonBinaryPropertyV4Test.java
deleted file mode 100644
index ec65bdc4..00000000
--- a/jackson/src/test/java/org/linguafranca/pwdb/JacksonBinaryPropertyV4Test.java
+++ /dev/null
@@ -1,66 +0,0 @@
-/*
- * Copyright 2023 Giuseppe Valente
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.linguafranca.pwdb;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-
-import org.linguafranca.pwdb.checks.BinaryPropertyChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-
-public class JacksonBinaryPropertyV4Test extends BinaryPropertyChecks{
-
-
- public JacksonBinaryPropertyV4Test() throws Exception{
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("V4-ChaCha20-Argon2-Attachment.kdbx");
- database = JacksonDatabase.load(new KdbxCreds("123".getBytes()), inputStream);
- }
-
-
- @Override
- public void saveDatabase(Database database, Credentials credentials, OutputStream outputStream) throws IOException {
- database.save(credentials, outputStream);
- }
-
- @Override
- public Database loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- try {
- return JacksonDatabase.load(credentials, inputStream);
- } catch (Exception e) {
- throw new RuntimeException(e);
- }
- }
-
- @Override
- public Database newDatabase() {
- Database result = null;
- try {
- result = new JacksonDatabase();
- } catch (Exception e) {
- throw new RuntimeException(e);
- }
- return result;
-
- }
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds(creds);
- }
-
-}
diff --git a/jackson/src/test/java/org/linguafranca/pwdb/JacksonDatabaseLoadTest.java b/jackson/src/test/java/org/linguafranca/pwdb/JacksonDatabaseLoadTest.java
deleted file mode 100644
index 2f0e4d2e..00000000
--- a/jackson/src/test/java/org/linguafranca/pwdb/JacksonDatabaseLoadTest.java
+++ /dev/null
@@ -1,72 +0,0 @@
-/*
- * Copyright 2023 Giuseppe Valente
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.linguafranca.pwdb;
-
-import java.io.InputStream;
-import java.io.PrintStream;
-
-import org.junit.Test;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-public class JacksonDatabaseLoadTest {
-
- static PrintStream printStream = getTestPrintStream();
-
-
- @Test
- public void loadXml() throws Exception {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("ExampleDatabase.xml");
- JacksonDatabase database = JacksonDatabase.loadXml(inputStream);
- database.visit(new Visitor.Print(printStream));
- }
- @Test
- public void loadKdbx() throws Exception {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("test123.kdbx");
- JacksonDatabase database = JacksonDatabase.load(new KdbxCreds("123".getBytes()), inputStream);
- database.visit(new Visitor.Print(printStream));
- }
-
- @Test
- public void loadKdbxV4() throws Exception {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("V4-AES-Argon2.kdbx");
- JacksonDatabase database = JacksonDatabase.load(new KdbxCreds("123".getBytes()), inputStream);
- database.visit(new Visitor.Print(printStream));
- // test what happens to dates in V4
- database.visit(new Visitor.Default(){
- @Override
- public void visit(Entry entry) {
- printStream.println(entry.getCreationTime());
- }
- });
- }
-
- @Test
- public void emptyDb() throws Exception {
- JacksonDatabase database = new JacksonDatabase();
- printStream.println(database.getDescription());
- }
-
- @Test
- public void dbWithDeleted() throws Exception {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("testDeleted.kdbx");
- JacksonDatabase database = JacksonDatabase.load(new KdbxCreds("123".getBytes()), inputStream);
- database.visit(new Visitor.Print(printStream));
- }
-
-}
diff --git a/jackson/src/test/java/org/linguafranca/pwdb/JacksonDatabaseLoaderTest.java b/jackson/src/test/java/org/linguafranca/pwdb/JacksonDatabaseLoaderTest.java
deleted file mode 100644
index 7c218fc3..00000000
--- a/jackson/src/test/java/org/linguafranca/pwdb/JacksonDatabaseLoaderTest.java
+++ /dev/null
@@ -1,34 +0,0 @@
-/*
- * Copyright 2023 Giuseppe Valente
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.linguafranca.pwdb;
-
-import java.io.InputStream;
-
-import org.linguafranca.pwdb.checks.DatabaseLoaderChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-
-public class JacksonDatabaseLoaderTest extends DatabaseLoaderChecks{
-
-
- public JacksonDatabaseLoaderTest() throws Exception{
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream("test123.kdbx");
- // file has password credentials
- Credentials credentials = new KdbxCreds("123".getBytes());
- super.database = JacksonDatabase.load(credentials, inputStream);
- }
-
-}
diff --git a/jackson/src/test/java/org/linguafranca/pwdb/JacksonPropertyValueTest.java b/jackson/src/test/java/org/linguafranca/pwdb/JacksonPropertyValueTest.java
deleted file mode 100644
index 40571e53..00000000
--- a/jackson/src/test/java/org/linguafranca/pwdb/JacksonPropertyValueTest.java
+++ /dev/null
@@ -1,56 +0,0 @@
-/*
- * Copyright 2024 Jo Rabin
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.linguafranca.pwdb;
-
-import org.linguafranca.pwdb.checks.BasicDatabaseChecks;
-import org.linguafranca.pwdb.checks.PropertyValueChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.KdbxHeader;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonEntry;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonGroup;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonIcon;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-
-public class JacksonPropertyValueTest extends PropertyValueChecks {
-
- public JacksonPropertyValueTest() throws IOException {
- super(true);
- }
-
- @Override
- public void saveDatabase(JacksonDatabase database, Credentials credentials, OutputStream outputStream) throws IOException {
- database.save(credentials, outputStream);
- }
-
- @Override
- public JacksonDatabase loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- return JacksonDatabase.load(credentials, inputStream);
- }
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds(creds);
- }
- @Override
- public JacksonDatabase createDatabase() throws IOException {
- return new JacksonDatabase();
- }
-
-}
diff --git a/jackson/src/test/java/org/linguafranca/pwdb/JacksonSaveAndReloadTest.java b/jackson/src/test/java/org/linguafranca/pwdb/JacksonSaveAndReloadTest.java
deleted file mode 100644
index fcb2db76..00000000
--- a/jackson/src/test/java/org/linguafranca/pwdb/JacksonSaveAndReloadTest.java
+++ /dev/null
@@ -1,87 +0,0 @@
-/*
- * Copyright 2023 Giuseppe Valente
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.linguafranca.pwdb;
-
-import static org.junit.Assert.assertTrue;
-import static org.linguafranca.util.TestUtil.getTestPrintStream;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStream;
-import java.io.PrintStream;
-
-import org.junit.Test;
-import org.linguafranca.pwdb.checks.SaveAndReloadChecks;
-import org.linguafranca.pwdb.kdbx.KdbxCreds;
-import org.linguafranca.pwdb.kdbx.KdbxHeader;
-
-import org.linguafranca.pwdb.kdbx.jackson.JacksonDatabase;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonEntry;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonGroup;
-import org.linguafranca.pwdb.kdbx.jackson.JacksonIcon;
-
-
-public class JacksonSaveAndReloadTest extends SaveAndReloadChecks{
-
- @Override
- public JacksonDatabase getDatabase() {
- try {
- return new JacksonDatabase();
- } catch(Exception e) {
- return null;
- }
-
- }
-
- @Override
- public JacksonDatabase getDatabase(String name, Credentials credentials) throws IOException {
- InputStream inputStream = getClass().getClassLoader().getResourceAsStream(name);
- return JacksonDatabase.load(credentials, inputStream);
- }
-
- @Override
- public void saveDatabase(JacksonDatabase database, Credentials credentials, OutputStream outputStream) throws IOException {
- database.save(credentials, outputStream);
- }
-
- @Override
- public JacksonDatabase loadDatabase(Credentials credentials, InputStream inputStream) throws IOException {
- return JacksonDatabase.load(credentials, inputStream);
- }
-
-
- @Override
- public boolean verifyStreamFormat(StreamFormat s1, StreamFormat s2) {
- KdbxHeader h1 = (KdbxHeader) s1.getStreamConfiguration();
- KdbxHeader h2 = (KdbxHeader) s1.getStreamConfiguration();
- return (h1.getVersion() == h2.getVersion() &&
- h1.getProtectedStreamAlgorithm().equals(h2.getProtectedStreamAlgorithm()) &&
- h1.getKeyDerivationFunction().equals(h2.getKeyDerivationFunction()) &&
- h1.getCipherAlgorithm().equals(h2.getCipherAlgorithm()));
- }
-
-
- @Override
- public Credentials getCreds(byte[] creds) {
- return new KdbxCreds(creds);
- }
-
-}
diff --git a/jaxb/bindings.xml b/jaxb/bindings.xml
deleted file mode 100644
index c6907af8..00000000
--- a/jaxb/bindings.xml
+++ /dev/null
@@ -1,62 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This class, while generated, is not used see {@link
- org.linguafranca.pwdb.kdbx.jaxb.org.linguafranca.pwdb.base.AbstractJaxbParentedBinding} which is the
- actual implementation class.
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/jaxb/gradle-source-sets.txt b/jaxb/gradle-source-sets.txt
deleted file mode 100644
index 195f0d4f..00000000
--- a/jaxb/gradle-source-sets.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-sourceSets {
- main {
- java {
- srcDirs = ['src/main/java', 'src/generated/java']
- }
- resources {
- srcDirs = ['src/main/resources']
- }
- }
- test{
- java {
- srcDirs = ['src/test/java']
- }
- resources {
- srcDirs = ['src/test/resources']
- }
- }
-}
\ No newline at end of file
diff --git a/jaxb/pom.xml b/jaxb/pom.xml
deleted file mode 100644
index 535b53de..00000000
--- a/jaxb/pom.xml
+++ /dev/null
@@ -1,111 +0,0 @@
-
-
-
-
-
- KeePassJava2-parent
- org.linguafranca.pwdb
- 2.2.3-SNAPSHOT
- ../pom.xml
-
- 4.0.0
-
- KeePassJava2-jaxb
- KeePassJava2 :: JAXB
- Contains a JAXB implementation for KDBX.
-
-
-
- org.linguafranca.pwdb
- KeePassJava2-kdbx
- ${project.version}
-
-
-
- javax.xml.bind
- jaxb-api
- 2.3.1
-
-
- com.sun.xml.bind
- jaxb-impl
- 2.3.9
-
-
- org.linguafranca.pwdb
- test
- ${project.version}
- test
-
-
- junit
- junit
- test
-
-
-
-
-
-
- org.apache.maven.plugins
- maven-compiler-plugin
- ${maven-compiler-plugin.version}
-
- ${java.version}
- ${java.version}
- src/generated/java
-
-
-
-
-
-
-
- generateJaxbSources
-
-
-
-
-
- org.codehaus.mojo
- jaxb2-maven-plugin
- 2.2
-
-
- xjc
-
- xjc
-
-
-
-
-
- ../KDBX.4.xsd
-
-
- bindings.xml
-
- org.linguafranca.pwdb.kdbx.jaxb.binding
- src/generated/java
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/jaxb/src/generated/java/META-INF/sun-jaxb.episode b/jaxb/src/generated/java/META-INF/sun-jaxb.episode
deleted file mode 100644
index c585a686..00000000
--- a/jaxb/src/generated/java/META-INF/sun-jaxb.episode
+++ /dev/null
@@ -1,53 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter1.java b/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter1.java
deleted file mode 100644
index 16005b3b..00000000
--- a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter1.java
+++ /dev/null
@@ -1,27 +0,0 @@
-//
-// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.8-b130911.1802
-// See http://java.sun.com/xml/jaxb
-// Any modifications to this file will be lost upon recompilation of the source schema.
-// Generated on: 2023.05.17 at 11:23:19 AM BST
-//
-
-
-package org.linguafranca.pwdb.kdbx.jaxb.binding;
-
-import java.util.Date;
-import javax.xml.bind.annotation.adapters.XmlAdapter;
-
-public class Adapter1
- extends XmlAdapter
-{
-
-
- public Date unmarshal(String value) {
- return (org.linguafranca.pwdb.kdbx.jaxb.util.DateAdapter.fromString(value));
- }
-
- public String marshal(Date value) {
- return (org.linguafranca.pwdb.kdbx.jaxb.util.DateAdapter.toString(value));
- }
-
-}
diff --git a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter2.java b/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter2.java
deleted file mode 100644
index 530b9b09..00000000
--- a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter2.java
+++ /dev/null
@@ -1,26 +0,0 @@
-//
-// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.8-b130911.1802
-// See http://java.sun.com/xml/jaxb
-// Any modifications to this file will be lost upon recompilation of the source schema.
-// Generated on: 2023.05.17 at 11:23:19 AM BST
-//
-
-
-package org.linguafranca.pwdb.kdbx.jaxb.binding;
-
-import javax.xml.bind.annotation.adapters.XmlAdapter;
-
-public class Adapter2
- extends XmlAdapter
-{
-
-
- public Boolean unmarshal(String value) {
- return (org.linguafranca.pwdb.kdbx.Helpers.toBoolean(value));
- }
-
- public String marshal(Boolean value) {
- return (org.linguafranca.pwdb.kdbx.Helpers.fromBoolean(value));
- }
-
-}
diff --git a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter3.java b/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter3.java
deleted file mode 100644
index aa3295be..00000000
--- a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Adapter3.java
+++ /dev/null
@@ -1,27 +0,0 @@
-//
-// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.8-b130911.1802
-// See http://java.sun.com/xml/jaxb
-// Any modifications to this file will be lost upon recompilation of the source schema.
-// Generated on: 2023.05.17 at 11:23:19 AM BST
-//
-
-
-package org.linguafranca.pwdb.kdbx.jaxb.binding;
-
-import java.util.UUID;
-import javax.xml.bind.annotation.adapters.XmlAdapter;
-
-public class Adapter3
- extends XmlAdapter
-{
-
-
- public UUID unmarshal(String value) {
- return (org.linguafranca.pwdb.kdbx.Helpers.uuidFromBase64(value));
- }
-
- public String marshal(UUID value) {
- return (org.linguafranca.pwdb.kdbx.Helpers.base64FromUuid(value));
- }
-
-}
diff --git a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/AutoType.java b/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/AutoType.java
deleted file mode 100644
index fe87bdea..00000000
--- a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/AutoType.java
+++ /dev/null
@@ -1,239 +0,0 @@
-//
-// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.8-b130911.1802
-// See http://java.sun.com/xml/jaxb
-// Any modifications to this file will be lost upon recompilation of the source schema.
-// Generated on: 2023.05.17 at 11:23:19 AM BST
-//
-
-
-package org.linguafranca.pwdb.kdbx.jaxb.binding;
-
-import java.util.ArrayList;
-import java.util.List;
-import javax.xml.bind.JAXBElement;
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlElementRef;
-import javax.xml.bind.annotation.XmlElementRefs;
-import javax.xml.bind.annotation.XmlType;
-import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
-
-
-/**
- * Stores everything related to auto-type for this wrappedEntry.
- * http://keepass.info/help/base/autotype.html
- *
- *
- *
Java class for autoType complex type.
- *
- *
The following schema fragment specifies the expected content contained within this class.
- *
- *
- *
- *
- */
- @XmlAccessorType(XmlAccessType.FIELD)
- @XmlType(name = "", propOrder = {
- "windowAndKeystrokeSequence"
- })
- public static class Association {
-
- @XmlElementRefs({
- @XmlElementRef(name = "KeystrokeSequence", type = JAXBElement.class, required = false),
- @XmlElementRef(name = "Window", type = JAXBElement.class, required = false)
- })
- protected List> windowAndKeystrokeSequence;
-
- /**
- * Gets the value of the windowAndKeystrokeSequence property.
- *
- *
- * This accessor method returns a reference to the live list,
- * not a snapshot. Therefore any modification you make to the
- * returned list will be present inside the JAXB object.
- * This is why there is not a set method for the windowAndKeystrokeSequence property.
- *
- *
- * For example, to add a new item, do as follows:
- *
- * Objects of the following type(s) are allowed in the list
- * {@link JAXBElement }{@code <}{@link String }{@code >}
- * {@link JAXBElement }{@code <}{@link String }{@code >}
- *
- *
- */
- public List> getWindowAndKeystrokeSequence() {
- if (windowAndKeystrokeSequence == null) {
- windowAndKeystrokeSequence = new ArrayList>();
- }
- return this.windowAndKeystrokeSequence;
- }
-
- }
-
-}
diff --git a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Binaries.java b/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Binaries.java
deleted file mode 100644
index 4090b908..00000000
--- a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/Binaries.java
+++ /dev/null
@@ -1,201 +0,0 @@
-//
-// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.8-b130911.1802
-// See http://java.sun.com/xml/jaxb
-// Any modifications to this file will be lost upon recompilation of the source schema.
-// Generated on: 2023.05.17 at 11:23:19 AM BST
-//
-
-
-package org.linguafranca.pwdb.kdbx.jaxb.binding;
-
-import java.util.ArrayList;
-import java.util.List;
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlAttribute;
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlType;
-import javax.xml.bind.annotation.XmlValue;
-import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
-
-
-/**
- * Binary field for elements are centrally stored in this element.
- * The same Binary element may be referenced from many Entries.
- *
- *
- *
Java class for binaries complex type.
- *
- *
The following schema fragment specifies the expected content contained within this class.
- *
- *
- *
- *
- */
-@XmlAccessorType(XmlAccessType.FIELD)
-@XmlType(name = "binaries", propOrder = {
- "binary"
-})
-public class Binaries {
-
- @XmlElement(name = "Binary")
- protected List binary;
-
- /**
- * Gets the value of the binary property.
- *
- *
- * This accessor method returns a reference to the live list,
- * not a snapshot. Therefore any modification you make to the
- * returned list will be present inside the JAXB object.
- * This is why there is not a set method for the binary property.
- *
- *
- * For example, to add a new item, do as follows:
- *
- * getBinary().add(newItem);
- *
- *
- *
- *
- * Objects of the following type(s) are allowed in the list
- * {@link Binaries.Binary }
- *
- *
- */
- public List getBinary() {
- if (binary == null) {
- binary = new ArrayList();
- }
- return this.binary;
- }
-
-
- /**
- *
Java class for anonymous complex type.
- *
- *
The following schema fragment specifies the expected content contained within this class.
- *
- *
- *
- *
- */
- @XmlAccessorType(XmlAccessType.FIELD)
- @XmlType(name = "", propOrder = {
- "value"
- })
- public static class Binary {
-
- @XmlValue
- protected byte[] value;
- @XmlAttribute(name = "ID")
- protected Integer id;
- @XmlAttribute(name = "Compressed")
- @XmlJavaTypeAdapter(Adapter2 .class)
- protected Boolean compressed;
-
- /**
- * Gets the value of the value property.
- *
- * @return
- * possible object is
- * byte[]
- */
- public byte[] getValue() {
- return value;
- }
-
- /**
- * Sets the value of the value property.
- *
- * @param value
- * allowed object is
- * byte[]
- */
- public void setValue(byte[] value) {
- this.value = value;
- }
-
- /**
- * Gets the value of the id property.
- *
- * @return
- * possible object is
- * {@link Integer }
- *
- */
- public Integer getID() {
- return id;
- }
-
- /**
- * Sets the value of the id property.
- *
- * @param value
- * allowed object is
- * {@link Integer }
- *
- */
- public void setID(Integer value) {
- this.id = value;
- }
-
- /**
- * Gets the value of the compressed property.
- *
- * @return
- * possible object is
- * {@link String }
- *
- */
- public Boolean getCompressed() {
- if (compressed == null) {
- return new Adapter2().unmarshal("False");
- } else {
- return compressed;
- }
- }
-
- /**
- * Sets the value of the compressed property.
- *
- * @param value
- * allowed object is
- * {@link String }
- *
- */
- public void setCompressed(Boolean value) {
- this.compressed = value;
- }
-
- }
-
-}
diff --git a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/BinaryField.java b/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/BinaryField.java
deleted file mode 100644
index 50581d10..00000000
--- a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/BinaryField.java
+++ /dev/null
@@ -1,164 +0,0 @@
-//
-// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.8-b130911.1802
-// See http://java.sun.com/xml/jaxb
-// Any modifications to this file will be lost upon recompilation of the source schema.
-// Generated on: 2023.05.17 at 11:23:19 AM BST
-//
-
-
-package org.linguafranca.pwdb.kdbx.jaxb.binding;
-
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlAttribute;
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlType;
-
-
-/**
- * If derived from a file then the Key element conventionally contains the file name.
- * I think it would be useful to add a mime type on this ...
- *
- * The Value element is the value of /./meta/binaries/binary/@ID that is referenced from this
- * binary.
- *
- *
- *
Java class for binaryField complex type.
- *
- *
The following schema fragment specifies the expected content contained within this class.
- *
- *
- *
- *
- */
- @XmlAccessorType(XmlAccessType.FIELD)
- @XmlType(name = "")
- public static class Value {
-
- @XmlAttribute(name = "Ref")
- protected Integer ref;
-
- /**
- * Gets the value of the ref property.
- *
- * @return
- * possible object is
- * {@link Integer }
- *
- */
- public Integer getRef() {
- return ref;
- }
-
- /**
- * Sets the value of the ref property.
- *
- * @param value
- * allowed object is
- * {@link Integer }
- *
- */
- public void setRef(Integer value) {
- this.ref = value;
- }
-
- }
-
-}
diff --git a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/CustomData.java b/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/CustomData.java
deleted file mode 100644
index cdd94c65..00000000
--- a/jaxb/src/generated/java/org/linguafranca/pwdb/kdbx/jaxb/binding/CustomData.java
+++ /dev/null
@@ -1,80 +0,0 @@
-//
-// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.8-b130911.1802
-// See http://java.sun.com/xml/jaxb
-// Any modifications to this file will be lost upon recompilation of the source schema.
-// Generated on: 2023.05.17 at 11:23:19 AM BST
-//
-
-
-package org.linguafranca.pwdb.kdbx.jaxb.binding;
-
-import java.util.ArrayList;
-import java.util.List;
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlAnyElement;
-import javax.xml.bind.annotation.XmlType;
-
-
-/**
- * Third party programs and plugins can put custom data here.
- * Unique element names should be used, e.g. "PluginName_ItemName".
- *
- *
- *
Java class for customData complex type.
- *
- *
The following schema fragment specifies the expected content contained within this class.
- *
- *
+ *