Arkana

Abstract

1. Introduction

Arkana noun ‧ secret knowledge¹ — ar‧ka‧na | \är-​ˈkā-​nə\ Store your keys and secrets away from your source code. Designed for Android and iOS projects.

Your project must be using Swift Package Manager or CocoaPods as dependency manager (or both). No support for Carthage.

2. Objective

Use dotenv files for Android and iOS projects.

This project demonstrates how Ruby, Android, Kotlin can be applied to a real-world Cybersecurity & Ethical Hacking problem.

3. Key Features / Modules

• In your config file, set the result_path to the desired name for the new Arkana module.
• Update your project's settings.gradle file to include this newly created Arkana module.
• Adjust the result_path in your config file to specify the existing Gradle module where you want to include the Arkana files.
• Change should_generate_gradle_build_file to false. This prevents the overwriting of your existing module's build.gradle file.

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Ruby and Bundler
• Android Studio (latest)
• JDK 17
• Android device or emulator
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/rogerluan/arkana.git
cd arkana

gem 'arkana'

gem install arkana

Usage: arkana [options]
    -c /path/to/your/.arkana.yml,    Path to your config file. Defaults to '.arkana.yml'
    -e /path/to/your/.env,           Path to your dotenv file. Defaults to '.env' if one exists.
    -l kotlin                        Language to produce keys for, e.g. kotlin, swift. Defaults to 'swift'.

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add logging and alert notifications (email / Telegram)
• Write a threat model document for the tool
• Package it with Docker for safe lab testing

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Which threat or attack does this project defend against?
2. What detection or protection technique is used and what are its limits?
3. How are false positives and false negatives handled?
4. Which cryptographic algorithms or security standards are involved?
5. What legal and ethical rules apply when testing a tool like this?

9. Source Code & License

This project is developed by rogerluan and published on GitHub under the BSD 2-Clause "Simplified" License. Please follow the license terms and credit the original author when you use or modify this code.