Skip to content

Commit dcb5a8b

Browse files
hamada147hamada147
committed
docs: renaming
Signed-off-by: Ahmed Moussa <[email protected]>
1 parent 50ff676 commit dcb5a8b

File tree

154 files changed

+432
-8471
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+432
-8471
lines changed

‎.github/ISSUE_TEMPLATE/1-bug-report.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug Report
3-
description: Report a bug in the Atala PRISM DIDComm
3+
description: Report a bug in Apollo
44

55
body:
66
- type: dropdown

‎.github/ISSUE_TEMPLATE/2-feature-request.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: 'Feature Request'
3-
description: Suggest a new feature for Atala PRISM DIDComm
3+
description: Suggest a new feature for Apollo
44

55
body:
66
- type: textarea

‎.github/workflows/pull-request.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ env:
1515
ATALA_GITHUB_ACTOR: ${{ secrets.ATALA_GITHUB_ACTOR }}
1616
ATALA_GITHUB_TOKEN: ${{ secrets.ATALA_GITHUB_TOKEN }}
1717

18-
on: [pull_request]
18+
on:
19+
pull_request:
20+
workflow_dispatch:
1921

2022
jobs:
2123
build:

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ Pods/
1414
*.jks
1515
*yarn.lock
1616
JSLibs/iohk-crypto/node_modules
17-
node_modules/
17+
node_modules/

‎.secretlintignore

-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +0,0 @@
1-
JWT/src/androidMain/kotlin/io/iohk/prism/apollo/jwt/RSAPlatform.kt
2-
JWT/src/jsMain/kotlin/io.iohk.prism.apollo.jwt/RSAPlatform.kt
3-
JWT/src/iosMain/kotlin/io.iohk.prism.apollo.jwt/RSAPlatform.kt

‎CONTRIBUTING.md

+93-47
Large diffs are not rendered by default.

‎Logo.png

-68.9 KB
Binary file not shown.

‎README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@
1111
![badge-platform-js]
1212
![badge-platform-js-node]
1313

14-
![Atala Prism Logo](Logo.png)
15-
1614
A cryptography lib built with Kotlin Multiplatform with support for the following targets:
1715

1816
- JS
@@ -159,7 +157,7 @@ repositories {
159157
For dependencies
160158
```kotlin
161159
dependencies {
162-
implementation("io.iohk.atala.prism.apollo:apollo:<latest version>")
160+
implementation("org.hyperledger.identus:apollo:<latest version>")
163161
}
164162
```
165163
@@ -234,7 +232,7 @@ kotlin {
234232
commonMain {
235233
dependencies {
236234
// This following is just an example you can import it as per you needs
237-
implementation 'io.iohk.atala.prism.apollo:apollo:<latest version>'
235+
implementation 'org.hyperledger.identus:apollo:<latest version>'
238236
}
239237
}
240238
}
@@ -258,7 +256,7 @@ kotlin {
258256
val commonMain by getting {
259257
dependencies {
260258
// This following is just an example you can import it as per you needs
261-
implementation("io.iohk.atala.prism.apollo:apollo:<latest version>")
259+
implementation("org.hyperledger.identus:apollo:<latest version>")
262260
}
263261
}
264262
}
@@ -268,7 +266,7 @@ kotlin {
268266
## How to use for Scala project
269267
270268
```scala
271-
libraryDependencies += "io.iohk.atala.prism.apollo" % "apollo-jvm" % "<latest version>"
269+
libraryDependencies += "org.hyperledger.identus" % "apollo-jvm" % "<latest version>"
272270
```
273271
274272
## Usage

‎apollo/build.gradle.kts

+46-44
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ kotlin {
244244
sourceSets {
245245
val commonMain by getting {
246246
dependencies {
247-
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2")
247+
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.3")
248248
implementation("com.ionspin.kotlin:bignum:0.3.9")
249249
implementation("org.kotlincrypto.macs:hmac-sha2:0.3.0")
250250
implementation("org.kotlincrypto.hash:sha2:0.4.0")
@@ -318,24 +318,28 @@ kotlin {
318318
}
319319

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

327327
if (os.isMacOsX) {
328-
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosX64Test") {
329-
device.set("iPhone 14 Plus")
328+
if (tasks.findByName("iosX64Test") != null) {
329+
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosX64Test") {
330+
device.set("iPhone 14 Plus")
331+
}
330332
}
331-
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosSimulatorArm64Test") {
332-
device.set("iPhone 14 Plus")
333+
if (tasks.findByName("iosSimulatorArm64Test") != null) {
334+
tasks.getByName<org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeSimulatorTest>("iosSimulatorArm64Test") {
335+
device.set("iPhone 14 Plus")
336+
}
333337
}
334338
}
335339
}
336340

337341
android {
338-
namespace = "io.iohk.atala.prism.apollo"
342+
namespace = "org.hyperledger.identus.apollo"
339343
compileSdk = 34
340344
sourceSets["main"].manifest.srcFile("src/androidMain/AndroidManifest.xml")
341345
defaultConfig {
@@ -360,39 +364,6 @@ android {
360364
}
361365
}
362366

363-
afterEvaluate {
364-
tasks.withType<KotlinCompile> {
365-
dependsOn(
366-
":iOSLibs:buildIOHKCryptoKitIphoneos",
367-
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
368-
":iOSLibs:buildIOHKCryptoKitMacosx",
369-
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
370-
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
371-
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
372-
)
373-
}
374-
tasks.withType<ProcessResources> {
375-
dependsOn(
376-
":iOSLibs:buildIOHKCryptoKitIphoneos",
377-
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
378-
":iOSLibs:buildIOHKCryptoKitMacosx",
379-
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
380-
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
381-
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
382-
)
383-
}
384-
tasks.withType<CInteropProcess> {
385-
dependsOn(
386-
":iOSLibs:buildIOHKCryptoKitIphoneos",
387-
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
388-
":iOSLibs:buildIOHKCryptoKitMacosx",
389-
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
390-
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
391-
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
392-
)
393-
}
394-
}
395-
396367
ktlint {
397368
filter {
398369
exclude("**/external/*", "./src/jsMain/kotlin/io/iohk/atala/prism/apollo/utils/external/*")
@@ -409,8 +380,7 @@ tasks.withType<DokkaTask>().configureEach {
409380
moduleVersion.set(rootProject.version.toString())
410381
description = "This is a Kotlin Multiplatform Library for cryptography"
411382
pluginConfiguration<org.jetbrains.dokka.base.DokkaBase, org.jetbrains.dokka.base.DokkaBaseConfiguration> {
412-
customAssets = listOf(rootDir.resolve("Logo.png"))
413-
footerMessage = "(c) ${Year.now().value} IOG Copyright"
383+
footerMessage = "(c) ${Year.now().value} HyberLedger Copyright"
414384
}
415385
dokkaSourceSets {
416386
configureEach {
@@ -448,13 +418,13 @@ tasks.withType<DokkaTask>().configureEach {
448418
}
449419

450420
npmPublish {
451-
organization.set("atala")
421+
organization.set("hyperledger")
452422
version.set(rootProject.version.toString())
453423
access.set(NpmAccess.PUBLIC)
454424
packages {
455425
access.set(NpmAccess.PUBLIC)
456426
named("js") {
457-
scope.set("atala")
427+
scope.set("hyperledger")
458428
packageName.set("apollo")
459429
readme.set(rootDir.resolve("README.md"))
460430
packageJson {
@@ -490,6 +460,38 @@ afterEvaluate {
490460
tasks.withType<PublishToMavenLocal> {
491461
dependsOn(tasks.withType<Sign>())
492462
}
463+
464+
tasks.withType<KotlinCompile> {
465+
dependsOn(
466+
":iOSLibs:buildIOHKCryptoKitIphoneos",
467+
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
468+
":iOSLibs:buildIOHKCryptoKitMacosx",
469+
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
470+
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
471+
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
472+
)
473+
}
474+
tasks.withType<ProcessResources> {
475+
dependsOn(
476+
":iOSLibs:buildIOHKCryptoKitIphoneos",
477+
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
478+
":iOSLibs:buildIOHKCryptoKitMacosx",
479+
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
480+
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
481+
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
482+
)
483+
}
484+
tasks.withType<CInteropProcess> {
485+
dependsOn(
486+
":iOSLibs:buildIOHKCryptoKitIphoneos",
487+
":iOSLibs:buildIOHKCryptoKitIphonesimulator",
488+
":iOSLibs:buildIOHKCryptoKitMacosx",
489+
":iOSLibs:buildIOHKSecureRandomGenerationIphoneos",
490+
":iOSLibs:buildIOHKSecureRandomGenerationIphonesimulator",
491+
":iOSLibs:buildIOHKSecureRandomGenerationMacosx"
492+
)
493+
}
494+
493495
// Disable publish of targets
494496
if (tasks.findByName("publishIosX64PublicationToSonatypeRepository") != null) {
495497
tasks.named("publishIosX64PublicationToSonatypeRepository") {

‎apollo/docs/Apollo.md

+23-19
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
11
# Module Apollo
22

3-
![Atala Prism Logo](./images/Logo.png)
4-
53
A cryptography lib built with Kotlin Multiplatform with support for the following targets:
64

75
- JS
86
- iOS
97
- Android
108
- JVM
119

12-
## Apollo: The Secure Foundation of Atala PRISM
10+
## Apollo: The Secure Foundation of Identus platform
1311

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

1816
### Key Features of Apollo:
1917

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

2832
## Security First:
2933

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

3438
## Empowering Secure Solutions:
3539

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

4145
## Cryptography Notice
4246

‎apollo/docs/Base64.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Package io.iohk.atala.prism.apollo.base64
1+
# Package org.hyperledger.identus.apollo.base64
22

33
Apollo Base64 is Kotlin Multiplatform library containing Standard & URL safe
44

‎apollo/docs/SecureRandom.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Package io.iohk.atala.prism.apollo.securerandom
1+
# Package org.hyperledger.identus.apollo.securerandom
22

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

‎apollo/src/androidMain/AndroidManifest.xml

-2
This file was deleted.

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/Platform.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/Platform.kt

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

33
/**
44
* The `Platform` class represents the platform on which the application is running.

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/derivation/Mnemonic.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/derivation/Mnemonic.kt

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

33
/**
44
* The Mnemonic class provides utility methods for working with mnemonic codes.

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/derivation/MnemonicCode.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/derivation/MnemonicCode.kt

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

33
/**
44
* A class representing a Mnemonic Code.

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/hashing/PBKDF2SHA512.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/hashing/PBKDF2SHA512.kt

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

33
import org.bitcoinj.crypto.PBKDF2SHA512
44

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/secp256k1/Secp256k1Lib.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/secp256k1/Secp256k1Lib.kt

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

33
import fr.acinq.secp256k1.Secp256k1
44
import org.kotlincrypto.hash.sha2.SHA256

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/securerandom/SecureRandom.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/securerandom/SecureRandom.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.iohk.atala.prism.apollo.securerandom
1+
package org.hyperledger.identus.apollo.securerandom
22

33
import android.os.Build
44

@@ -11,7 +11,7 @@ import android.os.Build
1111
*/
1212
actual class SecureRandom actual constructor(
1313
actual val seed: ByteArray
14-
) : SecureRandomInterface, java.security.SecureRandom() {
14+
) : org.hyperledger.identus.apollo.securerandom.SecureRandomInterface, java.security.SecureRandom() {
1515
/**
1616
* The `jvmSecureRandom` property provides a platform-specific implementation for generating secure random numbers.
1717
*

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/utils/JVMBigIntegerExt.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/utils/JVMBigIntegerExt.kt

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

33
import com.ionspin.kotlin.bignum.integer.Sign
44
import java.math.BigInteger

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/utils/KMMEdKeyPair.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/utils/KMMEdKeyPair.kt

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

33
import org.bouncycastle.crypto.generators.Ed25519KeyPairGenerator
44
import org.bouncycastle.crypto.params.Ed25519KeyGenerationParameters

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/utils/KMMEdPrivateKey.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/utils/KMMEdPrivateKey.kt

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

33
import org.bouncycastle.crypto.params.Ed25519PrivateKeyParameters
44
import org.bouncycastle.crypto.signers.Ed25519Signer

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/utils/KMMEdPublicKey.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/utils/KMMEdPublicKey.kt

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

33
import org.bouncycastle.crypto.params.Ed25519PublicKeyParameters
44
import org.bouncycastle.crypto.signers.Ed25519Signer

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/utils/KMMX25519KeyPair.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/utils/KMMX25519KeyPair.kt

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

33
import org.bouncycastle.crypto.generators.X25519KeyPairGenerator
44
import org.bouncycastle.crypto.params.X25519KeyGenerationParameters

‎apollo/src/androidMain/kotlin/io/iohk/atala/prism/apollo/utils/KMMX25519PrivateKey.kt ‎apollo/src/androidMain/kotlin/org/hyperledger/identus/apollo/utils/KMMX25519PrivateKey.kt

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

33
import org.bouncycastle.crypto.params.X25519PrivateKeyParameters
44

0 commit comments

Comments
 (0)