freeRASP brick

A brick for freeRASP to generate configuration code and automate necessary setup.

🚧 This brick is experimental and not stable! Changes to API/file generation reserved.

Overview

Setting up freeRASP can be quite tedious and repetitive. freerasp_brick provides you error-proof way to create configuration.

Features 🧰

• 🛠 Configuration generation
• 🎯 Dependency check using pub get
• 🔧 Fix apply using dart fix
• 🤖 Android SDK level check and automatic update
• 🍎 iOS script insertion in Runner.xcscheme (Experimental)

How to add ➕

Using BrickHub.dev

You can add freerasp_brick to your project just like any other brick:

mason add freerasp_brick

Using GitHub dependency

You can also add freerasp_brick to your project using --git-url option:

mason add --git-url https://github.com/yardexx/freerasp_brick freerasp_brick

💡 If you plan to use freeRASP in many different projects, it's useful to have freerasp_brick as global brick. You can do it by adding --global option.

How to use 🚀

You can generate freeRASP configuration by running:

mason make freerasp_brick

After providing necessary information, freerasp_brick will generate following file structure:

freerasp
├── freerasp.g.dart
└── freerasp_callback.g.dart

Then simply import freerasp.g.dart in your desired file and use it:

import 'freerasp/freerasp.g.dart';

// Some other code...

talsec.start();

Generated reactions 💣

Default generated reaction for every callback is print to console.

If you wish to change it, you can do so by editing freerasp_callback.g.dart file.

Variables 📦

⚠ Since freerasp_brick is heavily dependent on hooks, using -c option won't skip prompts generated by hooks.

Hooks 🎣

⚠ Brick won't generate files correctly if you disable pre-gen or post-gen hook.

Contribution 🤝

For issues, bugs, or feature proposals feel free to open issue or create PR.

Useful resources 📚

If this is your first touch with freeRASP or Mason, you refer to these resources to get started:

Getting started with freeRASP 🛡

• freeRASP on GitHub
• freeRASP website
• Medium article: freeRASP — In-App protection SDK and app security monitoring service

Getting started with mason 🧱

• Mason on GitHub
• Official Mason Documentation
• Code generation with Mason Blog
• Very Good Livestream: Felix Angelov Demos Mason

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add freerasp_brick

# Install globally
mason add -g freerasp_brick

Usage 🚀

mason make freerasp_brick

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.39 <0.1.0"

0.2.0

Version update and bug fixes.

🎯 Improvements

• Added compatibility for freeRASP 4.0.0

🛠 Fixed issues

• Post-script failed when scheme update were set to false

0.1.0

🎉 First release on BrickHub.dev! 🎉

🎯 Improvements

• Code checked
• Updated README
• Reformatted CHANGELOG
• Updated prompt messages

🛠 Fixed issues

• Properly showing progress message when successfully added script (iOS)

0.0.1-dev.5

✨ New Features

• Optional automatic iOS script insertion in Runner.xcscheme - experimental (iOS)

🎯 Improvements

• Updated README

🛠 Fixed issues

• Fixed incorrect mason version in brick.yaml
• Specified explicit mason version to >=0.1.0-dev.39 in pubspec.yaml

0.0.1-dev.4

✨ New Features

• Optional automatic minSdkLevel check and update (Android)

🎯 Improvements

• Updated README
• Updated CHANGELOG (uhm... sorry about that 😅)

0.0.1-dev.3

🎯 Improvements

• GitHub actions
• Code analysis

🛠 Fixed issues

• Dynamic types

0.0.1-dev.2

✨ New Features

• Automatic dependency fetching using pub add

🎯 Improvements

• Unified CLI prompt design
• Expanded README.md

🛠 Fixed issues

• Typos in README.md

0.0.1-dev.1

🎉 Initial version of freerasp_brick 🎉

✨ Features

• 🛠 Configuration generation
• 🎯 Dependency check using pub get
• 🔧 Fix apply using dart fix

MIT License

Copyright (c) 2022 Jaroslav Novotny

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.