{"id":19901867,"url":"https://github.com/hyperledger-identus/apollo","last_synced_at":"2025-05-02T23:32:00.121Z","repository":{"id":211230148,"uuid":"535641324","full_name":"hyperledger-identus/apollo","owner":"hyperledger-identus","description":"Collection of the cryptographic methods used all around identus","archived":false,"fork":false,"pushed_at":"2025-03-14T10:47:01.000Z","size":12927,"stargazers_count":11,"open_issues_count":5,"forks_count":4,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-30T20:49:36.781Z","etag":null,"topics":["crypto","cryptography","identus","kmm","kmp","kotlin","kotlin-android","kotlin-ios","kotlin-js","kotlin-jvm","kotlin-multiplatform"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperledger-identus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-12T11:48:24.000Z","updated_at":"2025-03-14T10:18:47.000Z","dependencies_parsed_at":"2023-12-11T11:52:21.455Z","dependency_job_id":"5a3f0589-da6d-4950-9a8b-2c298326caea","html_url":"https://github.com/hyperledger-identus/apollo","commit_stats":null,"previous_names":["input-output-hk/atala-prism-apollo","hyperledger/identus-apollo","hyperledger-identus/apollo"],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fapollo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fapollo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fapollo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fapollo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperledger-identus","download_url":"https://codeload.github.com/hyperledger-identus/apollo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252122287,"owners_count":21698305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crypto","cryptography","identus","kmm","kmp","kotlin","kotlin-android","kotlin-ios","kotlin-js","kotlin-jvm","kotlin-multiplatform"],"created_at":"2024-11-12T20:16:26.483Z","updated_at":"2025-05-02T23:32:00.110Z","avatar_url":"https://github.com/hyperledger-identus.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Apollo\n\n[![Kotlin](https://img.shields.io/badge/kotlin-1.9.22-blue.svg?logo=kotlin)](http://kotlinlang.org)\n![badge-license]\n![badge-latest-release]\n[![semantic-release-kotlin]](https://github.com/semantic-release/semantic-release)\n\n![badge-platform-android]\n![badge-platform-ios]\n![badge-platform-jvm]\n![badge-platform-js]\n![badge-platform-js-node]\n\nA cryptography lib built with Kotlin Multiplatform with support for the following targets:\n\n- JS\n- iOS\n- Android\n- JVM\n\n## How to build Apollo\n\n### Set Environment Variables\n\nSet variable `GITHUB_ACTOR` with your GitHub Username and set variable `GITHUB_TOKEN` with your GitHub Personal Access Token.\n\nAs an example we will go with `Bash`\n\n1. Open CMD.\n2. Run `sudo nano $HOME/.bash_profile`.\n3. Insert `export GITHUB_ACTOR=\"YOUR GITHUB USERNAME\"`\n4. Insert `export GITHUB_TOKEN=\"YOUR GITHUB PERSONAL ACCESS TOKEN\"`\n5. Save profile and restart CMD to take effect.\n\n### Install Homebrew (Mac Only)\n\n```bash\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n```\n\n### Install autoconf, automake \u0026 libtool (Mac Only)\n\n```bash\nbrew install autoconf automake libtool\n```\n\n### Install JDK 11\n\n```bash\ncs java --jvm adopt:1.11.0-11 --setup\n```\n\nafter that `java -version` should yield something like that\n\n```text\nopenjdk version \"11.0.11\" 2021-04-20\nOpenJDK Runtime Environment (build 11.0.11+9)\nOpenJDK 64-Bit Server VM (build 11.0.11+9, mixed mode)\n```\n\nIn case of using macOS with M chip, make sure to install the arch64 version of Java\n\n### Install XCode (Mac Only)\n\nInstall XCode from App Store. \n\nThen approve xcodebuild license in your terminal. Like so:\n```bash\n$ sudo xcodebuild -license\n```\n\n### Install Android SDK\n\nInstall Android SDK from SDK Manager (via Android Studio). \n\nThen approve Android SDK license. Like so:\n```bash\n$ cd /Users/{{YOUR USER}}/Library/Android/sdk\n$ tools/bin/sdkmanager --licenses\n```\nWhile there are many ways to install Android SDK this has proven to be the most reliable way. Standard IntelliJ with Android plugin may work. However, we've had several issues. Your mileage may vary.\n\nFor Ubuntu, \n```bash\nsudo apt update \u0026\u0026 sudo apt install android-sdk\n```\nLeaving the SDK at `~/Android/Sdk`\n\n### Create local.properties file\n\nCreate a file named `local.properties` in the root of Apollo.\n\nAdd your android sdk path to `local.properties file`. Like so:\n```properties\nsdk.dir = /Users/{{YOUR USER}}/Library/Android/sdk\n```\nThis will indicate to your IDE which android SDK to use.\n\nAlternatively, you can add the following environment variable into your shell profile file:\n```bash\n$ export ANDROID_HOME='/Users/{{YOUR USER}}/Library/Android/sdk\n```\n\n### Building the project\n\nInstall Rust packages:\n```bash\n$ ./scripts/install-rust-packages.sh\n```\n\nYou should be able to import and build the project in IntelliJ IDEA now. \n\n#### Troubleshooting\n\nHere is a list of common issues you might face and its solutions.\n\n##### Environment Variables were added but not available\n\nIf you already added the environment variable to your CMD profile and still not being available.\n\n**Solution**\n\n* Restart your Device.\n\n##### No binary for ChromeHeadless browser on your platform\n\nIf you get error:\n```log\nNo binary for ChromeHeadless browser on your platform.\nPlease, set \"CHROME_BIN\" env variable.\njava.lang.IllegalStateException: Errors occurred during launch of browser for testing.\n- ChromeHeadless\n```\n\n**Solution**\n\n* Install headless chrome or just Chrome browser\n\n##### In case IntelliJ was building but was still showing syntax error in Gradle Script\n\n**Solution**\n\n* Go to preference/settings and make sure to select the correct Java version 11.\n\n##### Could not find JNA native support\n\nif you get this error on macOS with M chip:\n```log\nCould not find JNA native support\n```\n**Solution**\n\n* Make sure that you are using Java version that is arch64.\n\n## How to use for JVM/Android app\n\nIn `build.gradle.kts` files include the dependency\n```kotlin\nrepositories {\n    mavenCentral()\n}\n```\nFor dependencies\n```kotlin\ndependencies {\n    implementation(\"org.hyperledger.identus:apollo:\u003clatest version\u003e\")\n}\n```\n\n## How to use for Swift app\n\n### Using SPM\n\nInside your `Package.swift` file, add the following\n```swift\ndependencies: [\n    .package(\n        url: \"git@github.com:hyperledger/identus-apollo.git\",\n        from: \"\u003clatest version\u003e\"\n    )\n]\n```\n### Using generated xcframework directly\n\nThe following instruction using Xcode 15\n1. Go the [Release Page](https://github.com/hyperledger-identus/apollo/releases) and check the latest version and download the `Apollo.xcframework.zip` file.\n2. Uncompress the downloaded file.\n3. Add the `Apollo.xcframework` to your Xcode project.\n4. When asked select Copy items if needed.\n5. Then go to the project configuration page in Xcode and check the Frameworks and Libraries section and add the `Apollo.xcframework` if not found then choose `Embed \u0026 Sign`.\n6. Then go to the build phase page and mark the framework as required.\n\n[!WARNING]\n**For Intel iOS simulator**: You need to add the following flag as YES `EMBEDDED_CONTENT_CONTAINS_SWIFT=YES` on the target like so:\n\n```swift\nPackage.swift\n\nPackage(\n   ...\n   targets: .testTarget(\n      ...\n      swiftSettings: [.define(\"EMBEDDED_CONTENT_CONTAINS_SWIFT=YES\")]\n      ...\n   )\n)\n\n```\n\n## How to use for Node.js app\n\nInside the `package.json`\n```json\n{\n    \"dependencies\": {\n        \"@atala/apollo\": \"\u003clatest version\u003e\"\n    }\n}\n```\n\n## How to use for another KMP (Kotlin Multiplatform) project\n\n### Using Groovy\n\nIn the project `build.gradle`\n```groovy\nallprojects {\n    repositories {\n        // along with all the other current existing repos add the following\n        mavenCentral()\n    }\n}\n```\nIn the module `build.gradle`\n```groovy\nkotlin {\n    sourceSets {\n        commonMain {\n            dependencies {\n                // This following is just an example you can import it as per you needs\n                implementation 'org.hyperledger.identus:apollo:\u003clatest version\u003e'\n            }\n        }\n    }\n}\n```\n\n### Using Kotlin DSL\n\nIn the project `build.gradle.kts`\n```kotlin\nallprojects {\n    repositories {\n        // along with all the other current existing repos add the following\n        mavenCentral()\n    }\n}\n```\n```kotlin\nkotlin {\n    sourceSets {\n        val commonMain by getting {\n            dependencies {\n                // This following is just an example you can import it as per you needs\n                implementation(\"org.hyperledger.identus:apollo:\u003clatest version\u003e\")\n            }\n        }\n    }\n}\n```\n\n## How to use for Scala project\n\n```scala\nlibraryDependencies += \"org.hyperledger.identus\" % \"apollo-jvm\" % \"\u003clatest version\u003e\"\n```\n\n## Usage\n\nPlease have a look at unit tests, more samples will be added soon.\n\n## Cryptography Notice\n\nThis distribution includes cryptographic software. The country in which you currently reside may \nhave restrictions on the import, possession, use, and/or re-export to another country, of encryption \nsoftware. BEFORE using any encryption software, please check your country's laws, regulations and policies \nconcerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. \nSee [http://www.wassenaar.org/](http://www.wassenaar.org/) for more information.\n\n## License\n\nThis software is provided 'as-is', without any express or implied warranty. In no event will the\nauthors be held liable for any damages arising from the use of this software. Permission is granted\nto anyone to use this software for any purpose, including commercial applications, and to alter it\nand redistribute it freely.\n\n\u003c!-- TAG_VERSION --\u003e\n[badge-latest-release]: https://img.shields.io/badge/latest--release-1.2.10-blue.svg?style=flat\n[badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat\n[semantic-release-kotlin]: https://img.shields.io/badge/semantic--release-kotlin-blue?logo=semantic-release\n\n\u003c!-- TAG_PLATFORMS --\u003e\n[badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat\n[badge-platform-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat\n[badge-platform-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat\n[badge-platform-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat\n[badge-platform-js-node]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger-identus%2Fapollo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperledger-identus%2Fapollo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger-identus%2Fapollo/lists"}