Skip to content

Commit 3dc5a59

Browse files
committed
release: v0.6.0
1 parent f9ab545 commit 3dc5a59

File tree

2 files changed

+117
-26
lines changed

2 files changed

+117
-26
lines changed

CHANGELOG.md

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,85 @@ All notable changes to this project will be documented in this file. This projec
44
## [Unreleased]
55

66

7+
<a name="v0.6.0"></a>
8+
## [v0.6.0] - 2020-05-28
9+
### Bug Fixes
10+
- use iota for permissions enum
11+
- readme doc, immugw start command
12+
- typos in immugw help
13+
- licence
14+
- modify BUILT_BY flag with user email to keep dist script functionalities in makefile
15+
- race condition while prefixing keys
16+
- various permissions-related issues
17+
- when fetching users, only fetch the latest version
18+
- admin user can change password of regular user without having to know his old password
19+
- immugw pid path consistency
20+
- SafeZAdd handler SafeZAdd tests. Fix ReferenceHandler test
21+
- safereference_handler, add tests [#264](https://github.com/vchain-us/vcn/issues/264)
22+
- safeset_handler test
23+
- [#260](https://github.com/vchain-us/vcn/issues/260)
24+
- implementation of user deactivate
25+
- rewrite user management to store user, password and permissions separately
26+
- fix bug on zadd server method
27+
- **cmd/helper:** fix osx build
28+
- **cmd/immuadmin/command/service:** fix error returned by GetDefaultConfigPath
29+
- **cmd/immuadmin/command/service:** fix immudb data uninstall
30+
- **cmd/immuclient:** Added missing documentations and renamed deprecated structures.
31+
- **cmd/immuclient:** Fixed wrong audit credentials error
32+
- **cmd/immuclient:** Added missing documentations and renamed deprecated structures.
33+
- **cmd/immuclient:** Fixed paths.
34+
- **cmd/immuclient/audit:** fix immuclient service installation
35+
- **cmd/immuclient/service:** fix config import
36+
37+
### Changes
38+
- rename back immugw "trust checker" to "auditor"
39+
- improve help for immugw auditor metrics
40+
- rename audit(or) to trust-check(er)
41+
- use status.Error instead of status.Errorf for static string
42+
- use Sprintf instead of string concat
43+
- extract root service from immugw trust checker
44+
- rename default immudb and immugw loggers
45+
- turn sys keys prefixes into constants
46+
- remove setup release in makefile
47+
- service_name inside release build script is configurable inside makefile. closes [#159](https://github.com/vchain-us/vcn/issues/159) closes [#239](https://github.com/vchain-us/vcn/issues/239)
48+
- remove ppc and arm target arch from makefile
49+
- add CD releases, certificate sign, vcn sign in makefile dist scripts
50+
- add dist scripts in makefile
51+
- fix typo in README.md
52+
- add changelog
53+
- add getByRawSafeIndex tests
54+
- move corruption checker inside immudb process
55+
- update docker files
56+
- immugw audit publishes -1 if empty db and -2 if error, otherwise 0 (check failed) or 1 (succeeded)
57+
- immugw audit publishes -1 value for result and root indexes in case the audit could not run (i.e. empty database, error etc.)
58+
- change immugw metrics port
59+
- refactoring file cache for immugw auditor
60+
- rename immugw trust-checker to auditor
61+
- move auditor package under client directory
62+
- **cmd:** fix corruption checker flag
63+
- **cmd/helper:** add path os wildcard resolver
64+
- **cmd/helper:** fix config path manager stub on linux
65+
- **cmd/helper:** remove useless var
66+
- **cmd/immuadmin:** path of service files and binaries are os dynamic
67+
- **cmd/immuclient:** add pid file management on windows
68+
- **immuadmin:** improve the very first login message
69+
70+
### Code Refactoring
71+
- refactor safeset_handler_test
72+
73+
### Features
74+
- Audit agent added to immuclient.
75+
- make metrics server start configurable through options to aid tests. MetricsServer must not be started as during tests because prometheus lib panis with: duplicate metrics collector registration attempted.
76+
- add immugw auditor
77+
- invalidate tokens by droping public and private keys for a specific user
78+
- check permissions dynamically
79+
- implement user permissions and admin command to set them
80+
- prefix user keys
81+
- update metrics from immugw auditor
82+
- **cmd/immuclient/command:** add getByRawSafeIndex method
83+
- **immugw:** add GET /lastaudit on metrics server
84+
85+
786
<a name="v0.6.0-RC2"></a>
887
## [v0.6.0-RC2] - 2020-05-19
988
### Bug Fixes
@@ -560,6 +639,7 @@ All notable changes to this project will be documented in this file. This projec
560639
- **tree:** MTH reference impl
561640

562641

563-
[Unreleased]: https://github.com/vchain-us/vcn/compare/v0.6.0-RC2...HEAD
642+
[Unreleased]: https://github.com/vchain-us/vcn/compare/v0.6.0...HEAD
643+
[v0.6.0]: https://github.com/vchain-us/vcn/compare/v0.6.0-RC2...v0.6.0
564644
[v0.6.0-RC2]: https://github.com/vchain-us/vcn/compare/v0.6.0-RC1...v0.6.0-RC2
565645
[v0.6.0-RC1]: https://github.com/vchain-us/vcn/compare/v0.0.0-20200206...v0.6.0-RC1

README.md

Lines changed: 36 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ The linux service is using the following defaults:
185185
| ----------------------- | ------------------ |
186186
| all configuration files | /etc/immudb |
187187
| all data files | /var/lib/immudb |
188-
| pid file | /var/run/immdb.pid |
188+
| pid file | /var/lib/immudb/immudb.pid |
189189
| log files | /var/log/immudb |
190190

191191

@@ -213,7 +213,7 @@ The linux service is using the following defaults:
213213
| File or configuration | location |
214214
| ----------------------- | ------------------ |
215215
| all configuration files | /etc/immudb |
216-
| pid file | /var/run/immgw.pid |
216+
| pid file | /var/lib/immudb/immugw.pid |
217217
| log files | /var/log/immudb |
218218

219219

@@ -222,11 +222,11 @@ The linux service is using the following defaults:
222222

223223
##### immudb
224224

225-
Simply run ```./immudb -d``` to start immudb locally in the background.
225+
Simply run `./immudb -d` to start immudb locally in the background.
226226

227227
If you want to stop immudb în that case you need to find the process `ps -ax | grep immudb` and then `kill -15 <pid>`. Windows PowerShell would be `Get-Process immudb* | Stop-Process`.
228228

229-
```
229+
```bash
230230
immudb - the lightweight, high-speed immutable database for systems and applications.
231231

232232
Environment variables:
@@ -240,6 +240,7 @@ Environment variables:
240240
IMMUDB_MTLS=false
241241
IMMUDB_AUTH=false
242242
IMMUDB_DETACHED=false
243+
IMMUDB_CONSISTENCY_CHECK=true
243244
IMMUDB_PKEY=./tools/mtls/3_application/private/localhost.key.pem
244245
IMMUDB_CERTIFICATE=./tools/mtls/3_application/certs/localhost.cert.pem
245246
IMMUDB_CLIENTCAS=./tools/mtls/2_intermediate/certs/ca-chain.cert.pem
@@ -258,6 +259,7 @@ Flags:
258259
--certificate string server certificate file path (default "./tools/mtls/3_application/certs/localhost.cert.pem")
259260
--clientcas string clients certificates list. Aka certificate authority (default "./tools/mtls/2_intermediate/certs/ca-chain.cert.pem")
260261
--config string config file (default path are configs or $HOME. Default filename is immudb.ini)
262+
--consistency-check enable consistency check monitor routine. To disable: --consistency-check=false (default true)
261263
-n, --dbname string db name (default "immudb")
262264
-d, --detached run immudb in background
263265
--dir string data folder (default "./db")
@@ -275,11 +277,11 @@ Use "immudb [command] --help" for more information about a command.
275277

276278
##### immugw
277279

278-
Simply run ```./immugw -d``` to start immugw on the same machine as immudb (test or dev environment) or pointing to the remote immudb system ```./immugw --immudb-address "immudb-server"```.
280+
Simply run `./immugw -d` to start immugw on the same machine as immudb (test or dev environment) or pointing to the remote immudb system ```./immugw --immudb-address "immudb-server"```.
279281

280282
If you want to stop immugw în that case you need to find the process `ps -ax | grep immugw` and then `kill -15 <pid>`. Windows PowerShell would be `Get-Process immugw* | Stop-Process`.
281283

282-
```
284+
```bash
283285
immu gateway: a smart REST proxy for immudb - the lightweight, high-speed immutable database for systems and applications.
284286
It exposes all gRPC methods with a REST interface while wrapping all SAFE endpoints with a verification service.
285287

@@ -307,33 +309,36 @@ Available Commands:
307309
version Show the immugw version
308310

309311
Flags:
310-
-a, --address string immugw host address (default "127.0.0.1")
311-
--certificate string server certificate file path (default "./tools/mtls/4_client/certs/localhost.cert.pem")
312-
--clientcas string clients certificates list. Aka certificate authority (default "./tools/mtls/2_intermediate/certs/ca-chain.cert.pem")
313-
--config string config file (default path are configs or $HOME. Default filename is immugw.toml)
314-
-d, --detached run immudb in background
315-
--dir string program files folder (default ".")
316-
-h, --help help for immugw
317-
-k, --immudb-address string immudb host address (default "127.0.0.1")
318-
-j, --immudb-port int immudb port number (default 3322)
319-
--logfile string log path with filename. E.g. /tmp/immugw/immugw.log
320-
-m, --mtls enable mutual tls
321-
--pidfile string pid path with filename. E.g. /var/run/immugw.pid
322-
--pkey string server private key path (default "./tools/mtls/4_client/private/localhost.key.pem")
323-
-p, --port int immugw port number (default 3323)
324-
--servername string used to verify the hostname on the returned certificates (default "localhost")
312+
-a, --address string immugw host address (default "127.0.0.1")
313+
--audit enable audit mode (continuously fetches latest root from server, checks consistency against a local root and saves the latest root locally)
314+
--audit-interval duration interval at which audit should run (default 5m0s)
315+
--audit-password string immudb password used to login during audit
316+
--audit-username string immudb username used to login during audit (default "immugwauditor")
317+
--certificate string server certificate file path (default "./tools/mtls/4_client/certs/localhost.cert.pem")
318+
--clientcas string clients certificates list. Aka certificate authority (default "./tools/mtls/2_intermediate/certs/ca-chain.cert.pem")
319+
--config string config file (default path are configs or $HOME. Default filename is immugw.toml)
320+
-d, --detached run immudb in background
321+
--dir string program files folder (default ".")
322+
-h, --help help for immugw
323+
-k, --immudb-address string immudb host address (default "127.0.0.1")
324+
-j, --immudb-port int immudb port number (default 3322)
325+
--logfile string log path with filename. E.g. /tmp/immugw/immugw.log
326+
-m, --mtls enable mutual tls
327+
--pidfile string pid path with filename. E.g. /var/run/immugw.pid
328+
--pkey string server private key path (default "./tools/mtls/4_client/private/localhost.key.pem")
329+
-p, --port int immugw port number (default 3323)
330+
--servername string used to verify the hostname on the returned certificates (default "localhost")
325331

326332
Use "immugw [command] --help" for more information about a command.
327333

328-
329334
```
330335
331336
332337
##### immuadmin
333338
334339
For security reasons we recommend using immuadmin only on the same system as immudb. User management is restricted to localhost usage. Simply run ```./immuadmin``` on the same machine.
335340
336-
```
341+
```bash
337342
CLI admin client for immudb - the lightweight, high-speed immutable database for systems and applications.
338343

339344
Environment variables:
@@ -359,7 +364,7 @@ Available Commands:
359364
set Update server config items: auth (none|password|cryptosig), mtls (true|false)
360365
stats Show statistics as text or visually with the '-v' option. Run 'immuadmin stats -h' for details.
361366
status Show heartbeat status
362-
user Perform various user-related operations: list, create, deactivate, change password
367+
user Perform various user-related operations: list, create, deactivate, change password, set permissions
363368
version Show the immuadmin version
364369

365370
Flags:
@@ -382,7 +387,7 @@ Use "immuadmin [command] --help" for more information about a command.
382387
383388
Simply run ```./immuclient``` on the same machine or ```./immuclient -a <immudb-host>```
384389
385-
```
390+
```bash
386391
CLI client for immudb - the lightweight, high-speed immutable database for systems and applications.
387392
Environment variables:
388393
IMMUCLIENT_IMMUDB-ADDRESS=127.0.0.1
@@ -403,6 +408,7 @@ Available Commands:
403408
current Return the last merkle tree root and index stored locally
404409
get Get item having the specified key
405410
getByIndex Return an element by index
411+
getByRawSafeIndex Return an element by index
406412
help Help about any command
407413
history Fetch history for the item having the specified key
408414
inclusion Check if specified index is included in the current tree
@@ -520,6 +526,11 @@ As immudb is compared to Amazon QLDB as well, we compared the performance using
520526
521527
## News
522528
529+
`May 28, 2020` - **[immudb v0.6.0 GA released!](https://github.com/codenotary/immudb/releases)**
530+
531+
We're thrilled to announce our GA Release v0.6.0 that contains many improvements, bug fixes and new audit features.
532+
533+
523534
`May 19, 2020` - **[immudb v0.6.0-rc2 released!](https://github.com/codenotary/immudb/releases)**
524535
525536
Release v0.6.0-rc2 is our second public release and contains an all new immuclient CLI as well as a built-in Trust Checker that does a server based continous consistency check.

0 commit comments

Comments
 (0)