Skip to content

Commit

Permalink
Doc update4
Browse files Browse the repository at this point in the history
  • Loading branch information
astitva1905 committed Sep 28, 2023
1 parent c2cfbc0 commit fa87164
Show file tree
Hide file tree
Showing 5 changed files with 102 additions and 60 deletions.
126 changes: 80 additions & 46 deletions servers/lib/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
--- Start of Definition of INTO-CPS Association Public License ---

/*

* This file is part of the INTO-CPS Association.
*
* Copyright (c) 2017-CurrentYear, INTO-CPS Association (ICA),
Expand All @@ -12,14 +13,16 @@
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS INTO-CPS ASSOCIATION PUBLIC LICENSE (ICAPL) VERSION 1.0.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE INTO-CPS ASSOCIATION PUBLIC LICENSE OR
* RECIPIENT'S ACCEPTANCE OF THE INTO-CPS ASSOCIATION PUBLIC LICENSE OR
* THE GPL VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
*
* The INTO-CPS tool suite software and the INTO-CPS Association
* Public License (ICAPL) are obtained from the INTO-CPS Association, either
* from the above address, from the URLs: http://www.into-cps.org or
* The INTO-CPS tool suite software and the INTO-CPS Association
* Public License (ICAPL) are obtained from the INTO-CPS Association, either
* from the above address, from the URLs:
* <http:>http://www.into-cps.org</http:> or
* in the INTO-CPS tool suite distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
* GNU version 3 is obtained from:
* <http:>http://www.gnu.org/copyleft/gpl.html</http:>.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
Expand All @@ -29,6 +32,7 @@
*
* See the full ICAPL conditions for more details.
*

*/

--- End of INTO-CPS Association Public License Header ---
Expand All @@ -37,38 +41,47 @@ The ICAPL is a public license for the INTO-CPS tool suite with three modes/alter
(GPL, ICA-Internal-EPL, ICA-External-EPL) for use and redistribution,
in source and/or binary/object-code form:

* GPL. Any party (member or non-member of the INTO-CPS Association) may use and
* GPL. Any party (member or non-member of the INTO-CPS Association) may use and
redistribute INTO-CPS tool suite under GPL version 3.

* Silver Level members of the INTO-CPS Association may also use and redistribute
* Silver Level members of the INTO-CPS Association may also
use and redistribute
the INTO-CPS tool suite under ICA-Internal-EPL conditions.

* Gold Level members of the INTO-CPS Association may also use and redistribute
* Gold Level members of the INTO-CPS Association may also use and redistribute
The INTO-CPS tool suite under ICA-Internal-EPL or ICA-External-EPL conditions.

Definitions of the INTO-CPS Association Public license modes:

* GPL = GPL version 3.

* ICA-Internal-EPL = These INTO-CPA Association Public license conditions together with
Internally restricted EPL, i.e., EPL version 1.0 with the Additional Condition
* ICA-Internal-EPL = These INTO-CPA Association
Public license conditions together with
Internally restricted EPL, i.e., EPL
version 1.0 with the Additional Condition
that use and redistribution by a member of the INTO-CPS Association is only allowed
within the INTO-CPS Association member's own organization (i.e., its own legal entity),
or for a member of the INTO-CPS Association paying a membership fee corresponding to
or for a member of the INTO-CPS Association
paying a membership fee corresponding to
the size of the organization including all its affiliates, use and redistribution
is allowed within/between its affiliates.

* ICA-External-EPL = These INTO-CPA Association Public license conditions together with
Externally restricted EPL, i.e., EPL version 1.0 with the Additional Condition
* ICA-External-EPL = These INTO-CPA Association
Public license conditions together with
Externally restricted EPL, i.e., EPL
version 1.0 with the Additional Condition
that use and redistribution by a member of the INTO-CPS Association, or by a Licensed
Third Party Distributor having a redistribution agreement with that member,
to parties external to the INTO-CPS Association member’s own organization (i.e., its own
to parties external to the INTO-CPS
Association member’s own organization (i.e., its own
legal entity) is only allowed in binary/object-code form, except the case of
redistribution to other members the INTO-CPS Association to which source is also
redistribution to other members the
INTO-CPS Association to which source is also
allowed to be distributed.

[This has the consequence that an external party who wishes to use
the INTO-CPS Association in source form together with its own proprietary software in all
the INTO-CPS Association in source form
together with its own proprietary software in all
cases must be a member of the INTO-CPS Association].

In all cases of usage and redistribution by recipients, the following
Expand All @@ -90,7 +103,8 @@ c) A recipient must clearly indicate its chosen usage mode of ICAPL,
in accompanying documentation and in a text file ICA-USAGE-MODE.txt,
provided with the distribution.

d) Contributor(s) making a Contribution to the INTO-CPS Association thereby also makes a
d) Contributor(s) making a Contribution
to the INTO-CPS Association thereby also makes a
Transfer of Contribution Copyright. In return, upon the effective date of
the transfer, ICA grants the Contributor(s) a Contribution License of the
Contribution. ICA has the right to accept or refuse Contributions.
Expand All @@ -108,12 +122,14 @@ ICA-Internal-EPL and ICA-External-EPL.
INTO-CPS Association Public License version 1.0, i.e., the license
defined here (the text between
"--- Start of Definition of INTO-CPS Association Public License ---" and
"--- End of Definition of INTO-CPS Association Public License ---", or later versions thereof.
"--- End of Definition of INTO-CPS
Association Public License ---", or later versions thereof.

"ICAPL Header" means:

INTO-CPS Association Public License Header version 1.2, i.e., the
text between "--- Start of Definition of INTO-CPS Association Public License ---" and
text between "--- Start of Definition of
INTO-CPS Association Public License ---" and
"--- End of INTO-CPS Association Public License Header ---, or later versions thereof.

"Contribution" means:
Expand All @@ -125,36 +141,48 @@ b) in the case of each subsequent Contributor:
i) changes to the INTO-CPS tool suite, and
ii) additions to the INTO-CPS tool suite;

where such changes and/or additions to the INTO-CPS tool suite originate from and are
where such changes and/or additions to the
INTO-CPS tool suite originate from and are
distributed by that particular Contributor. A Contribution 'originates' from
a Contributor if it was added to the INTO-CPS tool suite by such Contributor itself or
a Contributor if it was added to the INTO-CPS tool suite
by such Contributor itself or
anyone acting on such Contributor's behalf.

For Contributors licensing the INTO-CPS tool suite under ICA-Internal-EPL or
ICA-External-EPL conditions, the following conditions also hold:

Contributions do not include additions to the distributed Program which: (i)
are separate modules of software distributed in conjunction with the INTO-CPS tool suite
are separate modules of software distributed in
conjunction with the INTO-CPS tool suite
under their own license agreement, (ii) are separate modules which are not
derivative works of the INTO-CPS tool suite, and (iii) are separate modules of software
distributed in conjunction with the INTO-CPS tool suite under their own license agreement
where these separate modules are merged with (weaved together with) modules of
The INTO-CPS tool suite to form new modules that are distributed as object code or source
The INTO-CPS tool suite to form new modules that
are distributed as object code or source
code under their own license agreement, as allowed under the Additional
Condition of internal distribution according to ICA-Internal-EPL and/or
Additional Condition for external distribution according to ICA-External-EPL.

"Transfer of Contribution Copyright" means that the Contributors of a
Contribution transfer the ownership and the copyright of the Contribution to
the INTO-CPS Association, the INTO-CPS Association Copyright owner, for
inclusion in the INTO-CPS tool suite. The transfer takes place upon the effective date
when the Contribution is made available on the INTO-CPS Association web site under ICAPL, by
inclusion in the INTO-CPS tool suite.
The transfer takes place upon the effective date
when the Contribution is made available on the INTO-CPS
Association web site under ICAPL, by
such Contributors themselves or anyone acting on such Contributors' behalf.
The transfer is free of charge. If the Contributors or the INTO-CPS Association so wish,
an optional Copyright transfer agreement can be signed between the INTO-CPS Association and the Contributors.

"Contribution License" means a license from the INTO-CPS Association to the Contributors of the Contribution, effective on the date of the Transfer of Contribution Copyright,
where the INTO-CPS Association grants the Contributors a non-exclusive, world-wide, transferable, free of charge, perpetual license, including sublicensing rights, to use,
The transfer is free of charge. If the Contributors or
the INTO-CPS Association so wish,
an optional Copyright transfer agreement can be signed
between the INTO-CPS Association and the Contributors.

"Contribution License" means a license from the INTO-CPS
Association to the Contributors of the Contribution,
effective on the date of the Transfer of Contribution Copyright,
where the INTO-CPS Association grants the Contributors
a non-exclusive, world-wide, transferable, free of charge,
perpetual license, including sublicensing rights, to use,
have used, modify, have modified, reproduce and or have reproduced the
contributed material, for business and other purposes, including but not
limited to evaluation, development, testing, integration and merging with
Expand All @@ -166,18 +194,19 @@ the INTO-CPS tool chain.

"The Program" means the Contributions distributed in accordance with ICAPL.

"The INTO-CPS tool chain" means the Contributions distributed in accordance with ICAPL.
"The INTO-CPS tool chain" means the Contributions
distributed in accordance with ICAPL.

"Recipient" means anyone who receives the INTO-CPS tool chain under ICAPL,
including all Contributors.

"Licensed Third Party Distributor" means a reseller/distributor having signed
a redistribution/resale agreement in accordance with ICAPL and the INTO-CPS
Association Bylaws, with a Gold Level organizational member which is not an
Affiliate of the reseller/distributor, for distributing a product containing
part(s) of the INTO-CPS tool suite. The Licensed Third Party Distributor shall
only be allowed further redistribution to other resellers if the Gold Level
member is granting such a right to it in the redistribution/resale agreement
a redistribution/resale agreement in accordance with ICAPL and the INTO-CPS
Association Bylaws, with a Gold Level organizational member which is not an
Affiliate of the reseller/distributor, for distributing a product containing
part(s) of the INTO-CPS tool suite. The Licensed Third Party Distributor shall
only be allowed further redistribution to other resellers if the Gold Level
member is granting such a right to it in the redistribution/resale agreement
between the Gold Level member and the Licensed Third Party Distributor.

"Affiliate" shall mean any legal entity, directly or indirectly, through one
Expand All @@ -197,7 +226,8 @@ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Each Recipient is solely responsible for determining the
appropriateness of using and distributing the INTO-CPS tool suite and assumes all risks
appropriateness of using and distributing the
INTO-CPS tool suite and assumes all risks
associated with its exercise of rights under ICAPL , including but not
limited to the risks and costs of program errors, compliance with applicable
laws, damage to or loss of data, programs or equipment, and unavailability
Expand All @@ -211,16 +241,17 @@ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE INTO-CPS TOOL
SUITE OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE INTO-CPS TOOL
SUITE OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGES.

A Contributor licensing the INTO-CPS tool suite under ICA-Internal-EPL or
ICA-External-EPL may choose to distribute (parts of) the INTO-CPS tool suite
ICA-External-EPL may choose to distribute (parts of) the INTO-CPS tool suite
in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of ICAPL; or for the case of
redistribution of the INTO-CPS tool suite together with proprietary code it is a dual
redistribution of the INTO-CPS tool suite together
with proprietary code it is a dual
license where the INTO-CPS tool suite parts are distributed under ICAPL compatible
conditions and the proprietary code is distributed under proprietary license
conditions; and
Expand All @@ -235,8 +266,10 @@ damages, including direct, indirect, special, incidental and consequential
damages, such as lost profits;
iii) states that any provisions which differ from ICAPL are offered by that
Contributor alone and not by any other party; and
iv) states from where the source code for the INTO-CPS tool suite is available, and
informs licensees how to obtain it in a reasonable manner on or through a
iv) states from where the source code for the INTO-CPS
tool suite is available, and
informs licensees how to obtain it in a
reasonable manner on or through a
medium customarily used for software exchange.

When the INTO-CPS tool suite is made available in source code form:
Expand All @@ -258,9 +291,10 @@ This Agreement is governed by the laws of Denmark. The place of jurisdiction
for all disagreements related to this Agreement, is Aarhus, Denmark.

The EPL 1.0 license definition has been obtained from:
http://www.eclipse.org/legal/epl-v10.html. It is also reproduced in the INTO-CPS distribution.
<http:>http://www.eclipse.org/legal/epl-v10.html</http:>.
It is also reproduced in the INTO-CPS distribution.

The GPL Version 3 license definition has been obtained from
http://www.gnu.org/copyleft/gpl.html. It is also reproduced in the INTO-CPS distribution.
<http:>http://www.gnu.org/copyleft/gpl.html</http:>. It is also reproduced in the INTO-CPS distribution.

--- End of Definition of INTO-CPS Association Public License ---
8 changes: 5 additions & 3 deletions servers/lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ to get a sample file system structure for the lib microservice.

The microservices uses `.env` environment files to receive configuration.

In order to create this environment, you need to create a `.env` file, wherein you create the following environment variables,
In order to create this environment, you need to create a `.env` file,
wherein you create the following environment variables,
and insert with the correct-information relevant for your setup:

```
```env
PORT='4001'
MODE='local' or 'gitlab'
LOCAL_PATH ='/Users/<Username>/DTaaS/files'
Expand All @@ -46,7 +47,8 @@ The `TOKEN` should be set to your GitLab Group access API token.
For more information on how to create and use your access token,
[gitlab page](https://docs.gitlab.com/ee/user/group/settings/group_access_tokens.html).

Once you've generated a token, copy it and replace the value of `TOKEN` with your token for the gitlab group, can be found.
Once you've generated a token, copy it and replace
the value of `TOKEN` with your token for the gitlab group, can be found.

## User Commands

Expand Down
6 changes: 4 additions & 2 deletions servers/lib/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

Inorder to test the lib-MS, a specific file structure must be configured.

Since the tests are tested across two different modes, 'local' or 'gitlab', a homogenous file structure is required.
Since the tests are tested across two different modes,
'local' or 'gitlab', a homogenous file structure is required.

This file structure must be within 'files' aswell as within your working gitlab repository, as depicted below...
This file structure must be within 'files' aswell as within
your working gitlab repository, as depicted below...

local file system:

Expand Down
1 change: 1 addition & 0 deletions servers/lib/test/data/user2/tools/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# Tools
content123
21 changes: 12 additions & 9 deletions ssl/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Generate SSL Certificates for DTaaS application

Set the required passwords for private certificates in the **password** file. The first line will be used for the input password and the next line for the output password.
Set the required passwords for private certificates
in the **password** file. The first line will be used
for the input password and the next line for the output password.

## Using the shell script

Expand All @@ -22,23 +24,24 @@ to **servers/gateway/certs** directory.
1) Take private/client.key.p12 certificate for the next steps
1) open firefox browser in regular, non-private mode.
1) open preferences (about:preferences)
1) search for "certificates" --> Certificate Manager -->
1) search for "certificates" --> Certificate Manager -->
1) Authorities --> import ca.cert.pem and checkmark
Trust this CA to identify websites
Trust this CA to identify email users

1) Your Certificates --> Import --> Add PKCS12 format client certificate (client.key.p12)
The password for this certificate is "dtaas"

It's important to add the certificates inthe same order. Otherwise, certificate errors are shown.
It's important to add the certificates inthe same order.
Otherwise, certificate errors are shown.

1) Setting default client SSL certificate for mTLS
a) Open an empty tab and type `about:config`
b) Accept the risk and continue
1) Setting default client SSL certificate for mTLS
a) Open an empty tab and type `about:config`
b) Accept the risk and continue
c) In the search bar, type: `security.default_personal_cert = Select Automatically`

### References

1. https://kb.mit.edu/confluence/display/istcontrib/Default+Certificate+Selection+in+Firefox
1. https://unix.stackexchange.com/questions/644176/how-to-permanently-add-self-signed-certificate-in-firefox
1. https://www.jscape.com/blog/firefox-client-certificate
1. <http:>https://kb.mit.edu/confluence/display/istcontrib/Default+Certificate+Selection+in+Firefox</http:>
1. <http:>https://unix.stackexchange.com/questions/644176/how-to-permanently-add-self-signed-certificate-in-firefox</http:>
1. <http:>https://www.jscape.com/blog/firefox-client-certificate</http:>

0 comments on commit fa87164

Please sign in to comment.