Skip to content

Commit

Permalink
Create Glossary.md document in Markdown format - release v8.6.4 (#41)
Browse files Browse the repository at this point in the history
* - Updated version to 8.6.3
- Create Encryption document in Markdown format
- Added new Encryption document to SUMMARY.md for publishing.

* - Included package-lock.json
  • Loading branch information
HenkKodde authored Dec 5, 2019
1 parent 88c7a95 commit 45c47da
Show file tree
Hide file tree
Showing 5 changed files with 319 additions and 15 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The Open API for FSP Interoperability Specification includes the following docum
* [Encryption](#encryption)

## Glossary
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Glossary.pdf) provides the glossary for the Open API (Application Programming Interface) for FSP (Financial Service Provider) Interoperability (hereafter cited as **"the API"**). Terms have been compiled from three sources:
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/Glossary.md) provides the glossary for the Open API (Application Programming Interface) for FSP (Financial Service Provider) Interoperability (hereafter cited as **"the API"**). Terms have been compiled from three sources:
- ITU-T Digital Financial Services Focus Group Glossary (ITU-T),
- Feedback from Technology Service Providers (TSPs) in the PDP work groups (PDP) and
- Feedback from the L1P IST Reference Implementation team (RI).
Expand Down Expand Up @@ -104,7 +104,7 @@ JSON Web Encryption (JWE [RFC7516](https://tools.ietf.org/html/rfc7516) )must be
To support encryption for multiple fields of an API message, JWE is extended in this document to adapt to the requirements of the API.

## Encryption
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Encryption.pdf) details the security methods to be implemented for **the API** to ensure integrity and non-repudiation between the API client and the API server.
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/Encryption.md) details the security methods to be implemented for **the API** to ensure integrity and non-repudiation between the API client and the API server.

In information security, data integrity means maintaining and assuring the accuracy and completeness of data over its entire life-cycle. For the API, data integrity means that an API message cannot be modified in an unauthorized or undetected manner by parties involved in the API communication.

Expand Down
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

### Documents
* [Mojaloop Specifications Overview](README.md)
* [Glossary](documents/Glossary.md)
* [API Definition v1.0](documents/API Definition v1.0.md)
* [Encryption](documents/Encryption.md)
### Change Control Board
Expand Down
35 changes: 23 additions & 12 deletions documents/Encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,29 @@

**Table of Contents**

- [1. Preface](#1-preface)
- [1.1 Conventions Used in This Document](#11-conventions-used-in-this-document)
- [1.2 Document Version Information](#21-document-version-information)
- [2. Introduction](#2-introduction)
- [1.2 Open API for FSP Interoperability Specification](#21-open-api-for-fsp-interoperability-specification)
- [3. API Encryption Definition](#3-api-encryption-definition)
- [3.1 Encrypt Data Model](#31-encryption-data-model)
- [3.2 Encrypt Fields of API Message](#32-encrypt-fields-of-api-message)
- [3.3 Decrypt Fields of API Message](#33-decrypt-fields-of-api-message)
- [4. API Encryption/Decryption Examples](#4-api-encryptiondecryption-examples)
- [4.1 Encryption Example](#41-encryption-example)
- [4.2 Decryption Exsample](#42-decryption-example)
1. [Preface](#1-preface)

1.1 [Conventions Used in This Document](#11-conventions-used-in-this-document)

1.2 [Document Version Information](#21-document-version-information)

2. [Introduction](#2-introduction)

1.2 [Open API for FSP Interoperability Specification](#21-open-api-for-fsp-interoperability-specification)

3. [API Encryption Definition](#3-api-encryption-definition)

3.1 [Encrypt Data Model](#31-encryption-data-model)

3.2 [Encrypt Fields of API Message](#32-encrypt-fields-of-api-message)

3.3 [Decrypt Fields of API Message](#33-decrypt-fields-of-api-message)

4. [API Encryption/Decryption Examples](#4-api-encryptiondecryption-examples)

4.1 [Encryption Example](#41-encryption-example)

4.2 [Decryption Exsample](#42-decryption-example)

**Table of Tables**

Expand Down
Loading

0 comments on commit 45c47da

Please sign in to comment.