Skip to content

Commit

Permalink
docs: renaming
Browse files Browse the repository at this point in the history
Signed-off-by: Ahmed Moussa <[email protected]>
  • Loading branch information
hamada147 committed May 20, 2024
1 parent 50ff676 commit 02b6e69
Show file tree
Hide file tree
Showing 154 changed files with 431 additions and 8,469 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug Report
description: Report a bug in the Atala PRISM DIDComm
description: Report a bug in Apollo

body:
- type: dropdown
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2-feature-request.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 'Feature Request'
description: Suggest a new feature for Atala PRISM DIDComm
description: Suggest a new feature for Apollo

body:
- type: textarea
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ env:
ATALA_GITHUB_ACTOR: ${{ secrets.ATALA_GITHUB_ACTOR }}
ATALA_GITHUB_TOKEN: ${{ secrets.ATALA_GITHUB_TOKEN }}

on: [pull_request]
on:
pull_request:
workflow_dispatch:

jobs:
build:
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Pods/
*.jks
*yarn.lock
JSLibs/iohk-crypto/node_modules
node_modules/
node_modules/
3 changes: 0 additions & 3 deletions .secretlintignore
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
JWT/src/androidMain/kotlin/io/iohk/prism/apollo/jwt/RSAPlatform.kt
JWT/src/jsMain/kotlin/io.iohk.prism.apollo.jwt/RSAPlatform.kt
JWT/src/iosMain/kotlin/io.iohk.prism.apollo.jwt/RSAPlatform.kt
140 changes: 93 additions & 47 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

Binary file removed Logo.png
Binary file not shown.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
![badge-platform-js]
![badge-platform-js-node]

![Atala Prism Logo](Logo.png)

A cryptography lib built with Kotlin Multiplatform with support for the following targets:

- JS
Expand Down Expand Up @@ -159,7 +157,7 @@ repositories {
For dependencies
```kotlin
dependencies {
implementation("io.iohk.atala.prism.apollo:apollo:<latest version>")
implementation("org.hyperledger.identus:apollo:<latest version>")
}
```
Expand Down Expand Up @@ -234,7 +232,7 @@ kotlin {
commonMain {
dependencies {
// This following is just an example you can import it as per you needs
implementation 'io.iohk.atala.prism.apollo:apollo:<latest version>'
implementation 'org.hyperledger.identus:apollo:<latest version>'
}
}
}
Expand All @@ -258,7 +256,7 @@ kotlin {
val commonMain by getting {
dependencies {
// This following is just an example you can import it as per you needs
implementation("io.iohk.atala.prism.apollo:apollo:<latest version>")
implementation("org.hyperledger.identus:apollo:<latest version>")
}
}
}
Expand All @@ -268,7 +266,7 @@ kotlin {
## How to use for Scala project
```scala
libraryDependencies += "io.iohk.atala.prism.apollo" % "apollo-jvm" % "<latest version>"
libraryDependencies += "org.hyperledger.identus" % "apollo-jvm" % "<latest version>"
```
## Usage
Expand Down
87 changes: 45 additions & 42 deletions apollo/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.3")
implementation("com.ionspin.kotlin:bignum:0.3.9")
implementation("org.kotlincrypto.macs:hmac-sha2:0.3.0")
implementation("org.kotlincrypto.hash:sha2:0.4.0")
Expand Down Expand Up @@ -318,24 +318,28 @@ kotlin {
}

// Enable the export of KDoc (Experimental feature) to Generated Native targets (Apple, Linux, etc.)
targets.withType<org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget> {
targets.withType<KotlinNativeTarget> {
compilations.getByName("main") {
compilerOptions.options.freeCompilerArgs.add("-Xexport-kdoc")
}
}

if (os.isMacOsX) {
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosX64Test") {
device.set("iPhone 14 Plus")
if (tasks.findByName("iosX64Test") != null) {
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosX64Test") {
device.set("iPhone 14 Plus")
}
}
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosSimulatorArm64Test") {
device.set("iPhone 14 Plus")
if (tasks.findByName("iosSimulatorArm64Test") != null) {
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosSimulatorArm64Test") {
device.set("iPhone 14 Plus")
}
}
}
}

android {
namespace = "io.iohk.atala.prism.apollo"
namespace = "org.hyperledger.identus.apollo"
compileSdk = 34
sourceSets["main"].manifest.srcFile("src/androidMain/AndroidManifest.xml")
defaultConfig {
Expand All @@ -360,39 +364,6 @@ android {
}
}

afterEvaluate {
tasks.withType<KotlinCompile> {
dependsOn(
":iOSLibs:buildIOHKCryptoKitIphoneos",
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
":iOSLibs:buildIOHKCryptoKitMacosx",
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
)
}
tasks.withType<ProcessResources> {
dependsOn(
":iOSLibs:buildIOHKCryptoKitIphoneos",
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
":iOSLibs:buildIOHKCryptoKitMacosx",
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
)
}
tasks.withType<CInteropProcess> {
dependsOn(
":iOSLibs:buildIOHKCryptoKitIphoneos",
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
":iOSLibs:buildIOHKCryptoKitMacosx",
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
)
}
}

ktlint {
filter {
exclude("**/external/*", "./src/jsMain/kotlin/io/iohk/atala/prism/apollo/utils/external/*")
Expand Down Expand Up @@ -448,13 +419,13 @@ tasks.withType<DokkaTask>().configureEach {
}

npmPublish {
organization.set("atala")
organization.set("hyperledger")
version.set(rootProject.version.toString())
access.set(NpmAccess.PUBLIC)
packages {
access.set(NpmAccess.PUBLIC)
named("js") {
scope.set("atala")
scope.set("hyperledger")
packageName.set("apollo")
readme.set(rootDir.resolve("README.md"))
packageJson {
Expand Down Expand Up @@ -490,6 +461,38 @@ afterEvaluate {
tasks.withType<PublishToMavenLocal> {
dependsOn(tasks.withType<Sign>())
}

tasks.withType<KotlinCompile> {
dependsOn(
":iOSLibs:buildIOHKCryptoKitIphoneos",
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
":iOSLibs:buildIOHKCryptoKitMacosx",
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
)
}
tasks.withType<ProcessResources> {
dependsOn(
":iOSLibs:buildIOHKCryptoKitIphoneos",
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
":iOSLibs:buildIOHKCryptoKitMacosx",
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
)
}
tasks.withType<CInteropProcess> {
dependsOn(
":iOSLibs:buildIOHKCryptoKitIphoneos",
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
":iOSLibs:buildIOHKCryptoKitMacosx",
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
)
}

// Disable publish of targets
if (tasks.findByName("publishIosX64PublicationToSonatypeRepository") != null) {
tasks.named("publishIosX64PublicationToSonatypeRepository") {
Expand Down
42 changes: 23 additions & 19 deletions apollo/docs/Apollo.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,46 @@
# Module Apollo

![Atala Prism Logo](./images/Logo.png)

A cryptography lib built with Kotlin Multiplatform with support for the following targets:

- JS
- iOS
- Android
- JVM

## Apollo: The Secure Foundation of Atala PRISM
## Apollo: The Secure Foundation of Identus platform

Apollo is the robust cryptographic engine driving the security and privacy of Atala PRISM, a comprehensive suite of
blockchain-powered solutions. This collection of cryptographic methods provides the solid foundation upon which Atala PRISM
builds its diverse functionalities.
Apollo is the robust cryptographic engine driving the security and privacy of Identus platform, a comprehensive suite of
blockchain-powered solutions. This collection of cryptographic methods provides the solid foundation upon which Identus
platform builds its diverse functionalities.

### Key Features of Apollo:

- **Hashing:** Cryptographically secure hashing functions, including the widely trusted SHA-2 family and PBKDF2SHA512, ensure data integrity and prevent tampering.
- **Hashing:** Cryptographically secure hashing functions, including the widely trusted SHA-2 family and PBKDF2SHA512,
ensure data integrity and prevent tampering.
- **Base64 Encoding/Decoding:** This efficient encoding scheme allows secure transmission and storage of binary data.
- **Elliptic Curve Cryptography (Secp256k1):** This cutting-edge cryptographic algorithm provides robust digital signatures and key generation for secure transactions.
- **Secure Random Generation:** High-quality randomness is crucial for cryptographic processes, and Apollo employs advanced techniques to guarantee its integrity.
- **Key Derivation:** Securely deriving new cryptographic keys from existing ones enhances security and protects against key compromise.
- **Mnemonic Generation:** Transforming complex private keys into human-memorable phrases improves user experience and accessibility.
- **Hierarchical Deterministic Key Management (HDKey):** This powerful system allows generating a vast number of child keys from a single master key, facilitating robust key management for diverse applications.
- **Elliptic Curve Cryptography (Secp256k1):** This cutting-edge cryptographic algorithm provides robust digital
signatures and key generation for secure transactions.
- **Secure Random Generation:** High-quality randomness is crucial for cryptographic processes, and Apollo employs
advanced techniques to guarantee its integrity.
- **Key Derivation:** Securely deriving new cryptographic keys from existing ones enhances security and protects against
key compromise.
- **Mnemonic Generation:** Transforming complex private keys into human-memorable phrases improves user experience and
accessibility.
- **Hierarchical Deterministic Key Management (HDKey):** This powerful system allows generating a vast number of child
keys from a single master key, facilitating robust key management for diverse applications.

## Security First:

Apollo's commitment to security is paramount. It has undergone two independent security audits, further validating its
reliability and trustworthiness. This meticulous attention to security ensures that Atala PRISM operates at the highest
standards, safeguarding user data and privacy.
Apollo's commitment to security is paramount. It has undergone two independent security audits, further validating its
reliability and trustworthiness. This meticulous attention to security ensures that Identus platform operates at the
highest standards, safeguarding user data and privacy.

## Empowering Secure Solutions:

Through its robust cryptographic capabilities, Apollo empowers Atala PRISM to deliver a range of secure and privacy-preserving
solutions across various industries. From identity management and document verification to supply chain tracking and data
sharing, Apollo provides the essential cryptographic infrastructure for Atala PRISM to thrive in a connected world demanding
unparalleled security and trust.
Through its robust cryptographic capabilities, Apollo empowers Identus platform to deliver a range of secure and
privacy-preserving solutions across various industries. From identity management and document verification to supply
chain tracking and data sharing, Apollo provides the essential cryptographic infrastructure for Identus platform to
thrive in a connected world demanding unparalleled security and trust.

## Cryptography Notice

Expand Down
2 changes: 1 addition & 1 deletion apollo/docs/Base64.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Package io.iohk.atala.prism.apollo.base64
# Package org.hyperledger.identus.apollo.base64

Apollo Base64 is Kotlin Multiplatform library containing Standard & URL safe

Expand Down
2 changes: 1 addition & 1 deletion apollo/docs/SecureRandom.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Package io.iohk.atala.prism.apollo.securerandom
# Package org.hyperledger.identus.apollo.securerandom

Apollo Secure Random is Kotlin Multiplatform library to generate secure random bytes

Expand Down
2 changes: 0 additions & 2 deletions apollo/src/androidMain/AndroidManifest.xml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo
package org.hyperledger.identus.apollo

/**
* The `Platform` class represents the platform on which the application is running.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.derivation
package org.hyperledger.identus.apollo.derivation

/**
* The Mnemonic class provides utility methods for working with mnemonic codes.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.derivation
package org.hyperledger.identus.apollo.derivation

/**
* A class representing a Mnemonic Code.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.hashing
package org.hyperledger.identus.apollo.hashing

import org.bitcoinj.crypto.PBKDF2SHA512

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.secp256k1
package org.hyperledger.identus.apollo.secp256k1

import fr.acinq.secp256k1.Secp256k1
import org.kotlincrypto.hash.sha2.SHA256
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.securerandom
package org.hyperledger.identus.apollo.securerandom

import android.os.Build

Expand All @@ -11,7 +11,7 @@ import android.os.Build
*/
actual class SecureRandom actual constructor(
actual val seed: ByteArray
) : SecureRandomInterface, java.security.SecureRandom() {
) : org.hyperledger.identus.apollo.securerandom.SecureRandomInterface, java.security.SecureRandom() {
/**
* The `jvmSecureRandom` property provides a platform-specific implementation for generating secure random numbers.
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.utils
package org.hyperledger.identus.apollo.utils

import com.ionspin.kotlin.bignum.integer.Sign
import java.math.BigInteger
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.utils
package org.hyperledger.identus.apollo.utils

import org.bouncycastle.crypto.generators.Ed25519KeyPairGenerator
import org.bouncycastle.crypto.params.Ed25519KeyGenerationParameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.utils
package org.hyperledger.identus.apollo.utils

import org.bouncycastle.crypto.params.Ed25519PrivateKeyParameters
import org.bouncycastle.crypto.signers.Ed25519Signer
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.utils
package org.hyperledger.identus.apollo.utils

import org.bouncycastle.crypto.params.Ed25519PublicKeyParameters
import org.bouncycastle.crypto.signers.Ed25519Signer
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.utils
package org.hyperledger.identus.apollo.utils

import org.bouncycastle.crypto.generators.X25519KeyPairGenerator
import org.bouncycastle.crypto.params.X25519KeyGenerationParameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.utils
package org.hyperledger.identus.apollo.utils

import org.bouncycastle.crypto.params.X25519PrivateKeyParameters

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.utils
package org.hyperledger.identus.apollo.utils

/**
* Represents a public key for the X25519 elliptic curve encryption algorithm.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.iohk.atala.prism.apollo.derivation
package org.hyperledger.identus.apollo.derivation

final class Mnemonic {
companion object {
Expand Down
Loading

0 comments on commit 02b6e69

Please sign in to comment.