Merge remote-tracking branch 'origin/master' into add_fast_search_to_tempspace

Author: XaBbl4

.github/workflows/increment-build-number.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.FIREBIRD_INC_BUILDNUM }}
           persist-credentials: true

.github/workflows/qa.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Checkout firebird-qa
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 1
           repository: FirebirdSQL/firebird-qa

.github/workflows/trim-trailing-spaces.yml

@@ -17,7 +17,7 @@ jobs:
           - v4.0-release
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ matrix.branch }}
           persist-credentials: false

builds/install/misc/replication.conf

@@ -155,7 +155,7 @@ database
 	#   password_env = FB_REPL_PWD
 	# }
 	#
-	# If username_file / password_file is specified, the first non-empty line
+	# If username_file / password_file is specified, the first line
 	# of the provided file is used as the parameter value.
 	#
 	# If username_file or password_file values represent a relative pathname,

builds/make.new/config/install-sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 # install - install a program, script, or datafile
 
-scriptversion=2020-11-14.01; # UTC
+scriptversion=2023-11-23.18; # UTC
 
 # This originates from X11R5 (mit/util/scripts/install.sh), which was
 # later released in X11R6 (xc/config/util/install.sh) with the
@@ -124,9 +124,9 @@ it's up to you to specify -f if you want it.
 
 If -S is not specified, no backups are attempted.
 
-Email bug reports to [email protected].
-Automake home page: https://www.gnu.org/software/automake/
-"
+Report bugs to <[email protected]>.
+GNU Automake home page: <https://www.gnu.org/software/automake/>.
+General help using GNU software: <https://www.gnu.org/gethelp/>."
 
 while test $# -ne 0; do
   case $1 in

doc/README.isql_enhancements.txt

@@ -337,8 +337,8 @@ It is set to OFF by default. The name WIRE_STATS could be shortened up to WIRE.
 The statistics counters shown in two groups: 'logical' and 'physical':
   - logical counters show numbers of packets in terms of Firebird wire protocol
 	and number of bytes send before compression and received after decompression;
-  - physical counters show number of physical packets and bytes send and 
-	received over the wire, number of bytes could be affected by wire compression, 
+  - physical counters show number of physical packets and bytes send and
+	received over the wire, number of bytes could be affected by wire compression,
 	if present. Also, number of network roundtrips is shown: it is number of
 	changes of IO direction from 'send' to 'receive'.
 
@@ -489,7 +489,9 @@ If engine prepares the statement correctly, it's run and ISQL is put in new stat
 mode.
 
 If engine returns error isc_command_end_err2, then ISQL is put in statement
-continuation mode and asks for another line, repeating the process.
+continuation mode and asks for another line, repeating the process. When this error
+happens together with IStatement::PREPARE_REQUIRE_SEMICOLON, trace does not log the
+error.
 
 If engine returns a different error, the error is shown and ISQL is put in new statement
 mode.

doc/Using_OO_API.html

@@ -3629,13 +3629,24 @@ <h1><font size="4" style="font-size: 14pt">Database encryption
 <p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">DO_RETRY -
 	retry attach (ignored when function was called without attStatus).</font></p>
 	</font></p>
+	<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">
+	int getHashLength(StatusType* status) - returns length of hash of the keys provided by interface.
+	Hash is needed to let caller compare interfaces for equality. Empty (no keys)
+	interface should return hash length equal to zero.
+	</font></p>
+	<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">
+	void getHashData(StatusType* status, void* hash) - places hash of the keys provided by interface
+	into memory location defined by parameter <i>hash</i>. Should copy exact number of bytes
+	returned by getHashLength() call. Hash algorithm is chosen by plugin author
+	(in year 2024 SHA256 appears reasonable choice).
+	</font></p>
 </ol>
 <p style="margin-bottom: 0cm"><br/>
 
 </p>
 <p style="margin-bottom: 0cm"><a name="DbCryptInfo"></a><font size="4" style="font-size: 14pt">DbCryptInfo
 interface is passed to DbCryptPlugin by engine. Plugin may save this
-interface and use when needed to obtain additional informatio about
+interface and use when needed to obtain additional information about
 database.</font></p>
 <ol>
 	<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">const

examples/dbcrypt/CryptApplication.cpp

@@ -36,14 +36,28 @@ class CryptKey : public ICryptKeyCallbackImpl<CryptKey, CheckStatusWrapper>
 	{
 		if (length > 0 && buffer)
 		{
-			char k = 0x5a;
 			memcpy(buffer, &k, 1);
 			fprintf(stderr, "\nTransfered key to server\n");
 		}
 		return 1;
 	}
+
+	int getHashLength(Firebird::CheckStatusWrapper* status) override
+	{
+		return 1;
+	}
+
+	void getHashData(Firebird::CheckStatusWrapper* status, void* h) override
+	{
+		memcpy(h, &k, 1);
+	}
+
+private:
+	static const char k;
 };
 
+const char CryptKey::k = 0x5a;
+
 class App
 {
 public:

examples/dbcrypt/CryptKeyHolder.cpp

@@ -70,7 +70,7 @@ class CryptKeyHolder : public IKeyHolderPluginImpl<CryptKeyHolder, CheckStatusWr
 public:
 	explicit CryptKeyHolder(IPluginConfig* cnf) noexcept
 		: callbackInterface(this), named(NULL), tempStatus(master->getStatus()),
-		  config(cnf), key(0), owner(NULL)
+		  config(cnf), key(0), init(false), owner(NULL)
 	{
 		config->addRef();
 	}
@@ -111,10 +111,13 @@ class CryptKeyHolder : public IKeyHolderPluginImpl<CryptKeyHolder, CheckStatusWr
 		return owner;
 	}
 
-	ISC_UCHAR getKey()
+	const ISC_UCHAR& getKey()
 	{
-		if (!key)
+		if (!init)
+		{
 			keyCallback(&tempStatus, NULL);
+			init = true;
+		}
 
 		return key;
 	}
@@ -140,7 +143,7 @@ class CryptKeyHolder : public IKeyHolderPluginImpl<CryptKeyHolder, CheckStatusWr
 
 		unsigned int callback(unsigned int, const void*, unsigned int length, void* buffer) override
 		{
-			ISC_UCHAR k = holder->getKey();
+			const ISC_UCHAR& k = holder->getKey();
 			if (!k)
 			{
 				return 0;
@@ -153,6 +156,36 @@ class CryptKeyHolder : public IKeyHolderPluginImpl<CryptKeyHolder, CheckStatusWr
 			return 1;
 		}
 
+		int getHashLength(Firebird::CheckStatusWrapper* status) override
+		{
+			const ISC_UCHAR& k = holder->getKey();
+			if (!k)
+			{
+				ISC_STATUS err[] = {isc_arg_gds, isc_wish_list};
+				status->setErrors2(2, err);
+
+				return -1;
+			}
+
+			return 1;
+		}
+
+		void getHashData(Firebird::CheckStatusWrapper* status, void* h) override
+		{
+			// here key value is returned by hash function as is
+			// do not do it in production - use some hash function
+			const ISC_UCHAR& k = holder->getKey();
+			if (!k)
+			{
+				ISC_STATUS err[] = {isc_arg_gds, isc_wish_list};
+				status->setErrors2(2, err);
+
+				return;
+			}
+
+			memcpy(h, &k, 1);
+		}
+
 	private:
 		CryptKeyHolder* holder;
 	};
@@ -173,6 +206,18 @@ class CryptKeyHolder : public IKeyHolderPluginImpl<CryptKeyHolder, CheckStatusWr
 			return 1;
 		}
 
+		int getHashLength(Firebird::CheckStatusWrapper* status) override
+		{
+			return 1;
+		}
+
+		void getHashData(Firebird::CheckStatusWrapper* status, void* h) override
+		{
+			// here key value is returned by hash function as is
+			// do not do it in production - use some hash function
+			memcpy(h, &key, 1);
+		}
+
 		~NamedCallback()
 		{
 			delete next;
@@ -189,6 +234,7 @@ class CryptKeyHolder : public IKeyHolderPluginImpl<CryptKeyHolder, CheckStatusWr
 
 	IPluginConfig* config;
 	ISC_UCHAR key;
+	bool init;
 
 	std::atomic_int refCounter;
 	IReferenceCounted* owner;