Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@rowanshedden
rowanshedden authored Dec 17, 2023
1 parent 6aeae93 commit c32debf
Showing 1 changed file with 12 additions and 134 deletions.
146 changes: 12 additions & 134 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,156 +1,34 @@
# SITA Boarding Pass Issuer API
AACO demonstrator reference

The SITA Boarding Pass Issuer API is an Aries Cloud Agent - Python (ACA-Py) controller and server for SITA to issue self-sovereign identity (SSI) health credentials via ACA-Py (https://github.com/hyperledger/aries-cloudagent-python).

For an introduction to self-sovereign identity (SSI), please see [Phil Windley's article](https://www.windley.com/archives/2018/09/multi-source_and_self-sovereign_identity.shtml) on the topic.

To learn more about Aries and to connect with the Hyperledger Aries community, please visit the [Hyperledger Aries Wiki](https://wiki.hyperledger.org/display/ARIES/Hyperledger+Aries)

## Table of Contents
# License
Copyright © SITA Information Networking Computing USA inc 2020. Confidential. All rights reserved.

- [Features](#background)
- [Design](#install)
- [Installation](#install)
- [Quickstart](#usage)
- [Security](#security)
- [Docs](#api)
- [Credit](#credit)
- [Contributing](#contributing)
- [License](#license)
The use, republication or redistribution of this software is prohibited without the prior written consent of SITA Information Networking Computing USA or in accordance with a valid licence issued by SITA.

## Features

_TODO_

## Design

_TODO_

* Philosophy
* Goals/Requirements
* Use cases
* Big-picture diagrams

## Installation

### Separate Module Installation (non-containerized)
If you're running as separate modules not in a containerized context, create a .env File with the following variables specific to your setup (default agent address is localhost):
```
CONTROLLERPORT=3100
AGENTADDRESS='http://AGENT_IP_ADDRESS:8150'
```

If you need to reset your ecryption key (the raw key which is used by the algorithm and iv) for the SMTP password encrypyion, copy and run these commands to generate one. Then replace the old key with the new one ( e.g. LAB_ENC_KEY=40222988217e8dd592fc84fbf6ca20d7)
```
const crypto = require('crypto')
const enc_key = crypto.randomBytes(16).toString('hex')
console.log(enc_key)
```

Add the following line to your ACA-Py Agent startup.sh file:
```
--webhook-url "$WEBHOOK_ADDRESS" \
```

Add the controller ip-address (default localhost) and port (default port 3100) in your agent YML file for each agent the following line:
```
WEBHOOK_ADDRESS: http://CONTROLLER_IP_ADDRESS:CONTROLLER_PORT/api/controller-webhook
```

Run the following command to install the needed dependencies
```
npm install
```

Once the controller, agent, and database are all running, you will need to run a one-time startup script, which will also need to be ran everytime the agent and database are reset. This script will set up a public DID for you, provide the TAA for acceptance, and create a credential definition.
```
/bin/bash ./scripts/startupScript.sh
```

_TODO_

* Installing this app and dependencies (including cloud agent, network, etc.)
* OS requirements, etc.
* Quick test to make sure everything is working

## Quickstart

### Separate Module Quickstart (non-containerized)
Upon installation, run
```
npm run dev
/bin/bash ./scripts/startupScript.sh
```

## Deployment

In the project directory, you can run the following command to build the app for production to the `build` folder:

_TODO_

## Customization

_TODO: How to skin, guidelines around forking, etc._

## Security

_TODO_

## Docs

_TODO_

## Credit

_TODO_

## Contributing

If you are a new contributor to the project, please read our [contribution guide](./CONTRIBUTING.md) at least once; it will save you a few review cycles!

## License

Copyright © SITA Information Networking Computing USA inc 2020. Confidential. All rights reserved.

The use, republication or redistribution of this software is prohibited without the prior written consent of SITA Information Networking Computing USA or in accordance with a valid licence issued by SITA.

Other than as set out in any licence issued by SITA governing your use of this software, and to the extent allowed by law: (1) no warranty or representation (express or implied), including but not limited to the suitability, accuracy or fitness of this software for any purpose, or in respect of non-infringement of third party rights, is given; and (2) under no circumstances shall SITA be liable in respect of any use of this software by you, or any losses caused or suffered as a result.

## Developer Certificate of Origin (DCO)
Other than as set out in any licence issued by SITA governing your use of this software, and to the extent allowed by law: (1) no warranty or representation (express or implied), including but not limited to the suitability, accuracy or fitness of this software for any purpose, or in respect of non-infringement of third party rights, is given; and (2) under no circumstances shall SITA be liable in respect of any use of this software by you, or any losses caused or suffered as a result.

# Developer Certificate of Origin (DCO)
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

0 comments on commit c32debf

Please sign in to comment.