Skip to content

Commit

Permalink
release: v0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@mmeloni
mmeloni committed May 28, 2020
1 parent f9ab545 commit 3dc5a59
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 26 deletions.
82 changes: 81 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,85 @@ All notable changes to this project will be documented in this file. This projec
## [Unreleased]


<a name="v0.6.0"></a>
## [v0.6.0] - 2020-05-28
### Bug Fixes
- use iota for permissions enum
- readme doc, immugw start command
- typos in immugw help
- licence
- modify BUILT_BY flag with user email to keep dist script functionalities in makefile
- race condition while prefixing keys
- various permissions-related issues
- when fetching users, only fetch the latest version
- admin user can change password of regular user without having to know his old password
- immugw pid path consistency
- SafeZAdd handler SafeZAdd tests. Fix ReferenceHandler test
- safereference_handler, add tests [#264](https://github.com/vchain-us/vcn/issues/264)
- safeset_handler test
- [#260](https://github.com/vchain-us/vcn/issues/260)
- implementation of user deactivate
- rewrite user management to store user, password and permissions separately
- fix bug on zadd server method
- **cmd/helper:** fix osx build
- **cmd/immuadmin/command/service:** fix error returned by GetDefaultConfigPath
- **cmd/immuadmin/command/service:** fix immudb data uninstall
- **cmd/immuclient:** Added missing documentations and renamed deprecated structures.
- **cmd/immuclient:** Fixed wrong audit credentials error
- **cmd/immuclient:** Added missing documentations and renamed deprecated structures.
- **cmd/immuclient:** Fixed paths.
- **cmd/immuclient/audit:** fix immuclient service installation
- **cmd/immuclient/service:** fix config import

### Changes
- rename back immugw "trust checker" to "auditor"
- improve help for immugw auditor metrics
- rename audit(or) to trust-check(er)
- use status.Error instead of status.Errorf for static string
- use Sprintf instead of string concat
- extract root service from immugw trust checker
- rename default immudb and immugw loggers
- turn sys keys prefixes into constants
- remove setup release in makefile
- 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)
- remove ppc and arm target arch from makefile
- add CD releases, certificate sign, vcn sign in makefile dist scripts
- add dist scripts in makefile
- fix typo in README.md
- add changelog
- add getByRawSafeIndex tests
- move corruption checker inside immudb process
- update docker files
- immugw audit publishes -1 if empty db and -2 if error, otherwise 0 (check failed) or 1 (succeeded)
- immugw audit publishes -1 value for result and root indexes in case the audit could not run (i.e. empty database, error etc.)
- change immugw metrics port
- refactoring file cache for immugw auditor
- rename immugw trust-checker to auditor
- move auditor package under client directory
- **cmd:** fix corruption checker flag
- **cmd/helper:** add path os wildcard resolver
- **cmd/helper:** fix config path manager stub on linux
- **cmd/helper:** remove useless var
- **cmd/immuadmin:** path of service files and binaries are os dynamic
- **cmd/immuclient:** add pid file management on windows
- **immuadmin:** improve the very first login message

### Code Refactoring
- refactor safeset_handler_test

### Features
- Audit agent added to immuclient.
- 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.
- add immugw auditor
- invalidate tokens by droping public and private keys for a specific user
- check permissions dynamically
- implement user permissions and admin command to set them
- prefix user keys
- update metrics from immugw auditor
- **cmd/immuclient/command:** add getByRawSafeIndex method
- **immugw:** add GET /lastaudit on metrics server


<a name="v0.6.0-RC2"></a>
## [v0.6.0-RC2] - 2020-05-19
### Bug Fixes
Expand Down Expand Up @@ -560,6 +639,7 @@ All notable changes to this project will be documented in this file. This projec
- **tree:** MTH reference impl


[Unreleased]: https://github.com/vchain-us/vcn/compare/v0.6.0-RC2...HEAD
[Unreleased]: https://github.com/vchain-us/vcn/compare/v0.6.0...HEAD
[v0.6.0]: https://github.com/vchain-us/vcn/compare/v0.6.0-RC2...v0.6.0
[v0.6.0-RC2]: https://github.com/vchain-us/vcn/compare/v0.6.0-RC1...v0.6.0-RC2
[v0.6.0-RC1]: https://github.com/vchain-us/vcn/compare/v0.0.0-20200206...v0.6.0-RC1
61 changes: 36 additions & 25 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ The linux service is using the following defaults:
| ----------------------- | ------------------ |
| all configuration files | /etc/immudb |
| all data files | /var/lib/immudb |
| pid file | /var/run/immdb.pid |
| pid file | /var/lib/immudb/immudb.pid |
| log files | /var/log/immudb |


Expand Down Expand Up @@ -213,7 +213,7 @@ The linux service is using the following defaults:
| File or configuration | location |
| ----------------------- | ------------------ |
| all configuration files | /etc/immudb |
| pid file | /var/run/immgw.pid |
| pid file | /var/lib/immudb/immugw.pid |
| log files | /var/log/immudb |


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

##### immudb

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

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`.

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

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

##### immugw

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"```.
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"```.

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`.

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

Expand Down Expand Up @@ -307,33 +309,36 @@ Available Commands:
version Show the immugw version

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

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

```
##### immuadmin
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.
```
```bash
CLI admin client for immudb - the lightweight, high-speed immutable database for systems and applications.

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

Flags:
Expand All @@ -382,7 +387,7 @@ Use "immuadmin [command] --help" for more information about a command.
Simply run ```./immuclient``` on the same machine or ```./immuclient -a <immudb-host>```
```
```bash
CLI client for immudb - the lightweight, high-speed immutable database for systems and applications.
Environment variables:
IMMUCLIENT_IMMUDB-ADDRESS=127.0.0.1
Expand All @@ -403,6 +408,7 @@ Available Commands:
current Return the last merkle tree root and index stored locally
get Get item having the specified key
getByIndex Return an element by index
getByRawSafeIndex Return an element by index
help Help about any command
history Fetch history for the item having the specified key
inclusion Check if specified index is included in the current tree
Expand Down Expand Up @@ -520,6 +526,11 @@ As immudb is compared to Amazon QLDB as well, we compared the performance using
## News
`May 28, 2020` - **[immudb v0.6.0 GA released!](https://github.com/codenotary/immudb/releases)**
We're thrilled to announce our GA Release v0.6.0 that contains many improvements, bug fixes and new audit features.
`May 19, 2020` - **[immudb v0.6.0-rc2 released!](https://github.com/codenotary/immudb/releases)**
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.
Expand Down

0 comments on commit 3dc5a59

Please sign in to comment.