Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/approov/quickstart-flutter-elixir-phoenix-channels
Approov integration quickstart for mobile apps using a backend with Elixir Phoenix Channels
https://github.com/approov/quickstart-flutter-elixir-phoenix-channels
approov approov-flutter approov-integration approov-mobile approov-mobile-quickstart approov-quickstart flutter flutter-security mobile mobile-app-security mobile-security
Last synced: about 2 months ago
JSON representation
Approov integration quickstart for mobile apps using a backend with Elixir Phoenix Channels
- Host: GitHub
- URL: https://github.com/approov/quickstart-flutter-elixir-phoenix-channels
- Owner: approov
- License: mit
- Created: 2020-12-10T12:47:26.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-22T13:07:50.000Z (about 1 year ago)
- Last Synced: 2024-04-14T17:01:25.651Z (9 months ago)
- Topics: approov, approov-flutter, approov-integration, approov-mobile, approov-mobile-quickstart, approov-quickstart, flutter, flutter-security, mobile, mobile-app-security, mobile-security
- Language: Dart
- Homepage: https://approov.io
- Size: 251 KB
- Stars: 32
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Approov Quickstart: Flutter Elixir Phoenix Channels
[Approov](https://approov.io) is an API security solution used to verify that requests received by your backend services originate from trusted versions of your mobile apps.
This is an Approov integration quickstart for Flutter and using a backend with [Elixir Phoenix Channels](https://hexdocs.pm/phoenix/channels.html). Additionally, a step-by-step tutorial guide using a [Echo Chamber App](https://github.com/approov/quickstart-flutter-elixir-phoenix-channels/blob/master/ECHO-CHAMBER-EXAMPLE.md) is also available.
This package requires Flutter 3 because of the need to execute channel handlers on [background threads](https://docs.flutter.dev/development/platform-integration/platform-channels?tab=ios-channel-objective-c-tab#executing-channel-handlers-on-background-threads), which is only available in the stable channel from Flutter 3.
Note that the minimum OS requirement for iOS is 12 and for Android the minimum SDK version is 21 (Android 5.0). You cannot use Approov in apps that need to support OS versions older than this.
## ADDING APPROOV ENABLED ELIXIR PHOENIX CHANNELS
The Approov Enabled Elixir Phoenix Channels is available via a [`Github`](https://github.com/approov/approov-flutter-packages.git) package. This allows inclusion into the project by simply specifying a dependency in the `pubspec.yaml` files for the app. In the `dependencies:` section of `pubspec.yaml` file add the following package reference:
```yaml
phoenix_wings:
git:
url: https://github.com/approov/approov-flutter-packages.git
path: phoenix_wings
approov_web_socket:
git:
url: https://github.com/approov/approov-flutter-packages.git
path: approov_web_socket
approov_service_flutter_httpclient:
git: https://github.com/approov/approov-service-flutter-httpclient.git
```
Note that this creates a dependency on the latest version of the `approov-service-flutter-httpclient`, as do the dependencies in `approov-flutter-packages`. If you wish to create a dependency on a fixed tagged version you can use a syntax such as the following:
```yaml
approov_service_flutter_httpclient:
git:
url: https://github.com/approov/approov-service-flutter-httpclient.git
ref: 3.2.0
```
You will need to fork the `approov-flutter-packages` if you wish to fix their dependency to a specific tag.
The `phoenix_wings` package uses a predefined header to forward the Approov Token and also forwards the Approov SDK initialization string to the `approov_web_socket` package. The `approov_web_socket` package interacts with the `approov_service_flutter_httpclient` by means of an `ApproovHttpClient` object.
The `approov_service_flutter_httpclient` package is actually an open source wrapper layer that allows you to easily use Approov with `Flutter`. This has a further dependency to the closed source [Android Approov SDK](https://github.com/approov/approov-android-sdk) and [iOS Approov SDK](https://github.com/approov/approov-ios-sdk) packages. Those are automatically added as dependencies for the platform specific targets.
The `approov_service_flutter_httpclient` package provides a number of accessible classes:
1. `ApproovService` provides a higher level interface to the underlying Approov SDK
2. `ApproovException`, and derived `ApproovNetworkException` and `ApproovRejectionException`, provide special exception classes for Approov related errors
3. `ApproovHttpClient` which is a drop-in replacement for the Dart IO library's `HttpClient` and calls the `ApproovService`
4. `ApproovClient` which is a drop-in replacement for Client from the Flutter http package (https://pub.dev/packages/http) and internally uses an `ApproovHttpClient` object
### ANDROID MANIFEST CHANGES
The following app permissions need to be available in the manifest of your application to be able to use Approov:
```xml
```
Please [read this](https://approov.io/docs/latest/approov-usage-documentation/#targetting-android-11-and-above) section of the reference documentation if targetting Android 11 (API level 30) or above.
### IOS
The `approov_service_flutter_httpclient` generates a [Cocoapods](https://cocoapods.org) dependency file which must be installed by executing:
```Bash
pod install
```
in the directory containing the ios project files.
## USING APPROOV WITH PHOENIX CHANNELS
First, you need to instantiate the `PhoenixSocket` with an additional parameter and use it to `connect()`:
```Dart
PhoenixSocket socket = PhoenixSocket("${HttpService.websocketUrl}/socket/websocket",
'',
socketOptions: socket_options);
```
The `` is a custom string that configures your Approov account access. This will have been provided in your Approov onboarding email.
Now, you need to add the Approov token when you join to the Phoenix channel:
```dart
import 'package:approov_service_flutter_httpclient/approov_service_flutter_httpclient.dart';
Map urlParams = {
"X-Approov-Token": await ApproovService.fetchToken('your.api.domain.com')
};
final PhoenixChannel _channel = _socket.channel(channelName, urlParams);
```
Next, add the Approov token to the payload of each message sent to the Phoenix channel:
```dart
import 'package:approov_service_flutter_httpclient/approov_service_flutter_httpclient.dart';
Map payload = {
"X-Approov-Token": await ApproovService.fetchToken('your.api.domain.com'),
"message" : message
};
_channel.push(event: "name", payload: payload);
```
It's important that you also use the Approov token when joining to the channel and when sending messages to it, because your app environment can be compromised at any moment by an attacker, and when this occurs an invalid Approov token is sent in the API request headers to allow for your backend to reject any message it receives and to not send any data back as it would normally do.
## CHECKING IT WORKS
Initially you won't have set which API domains to protect, so the interceptor will not add anything. It will have called Approov though and made contact with the Approov cloud service. You will see logging from Approov saying `UNKNOWN_URL`.
Your Approov onboarding email should contain a link allowing you to access [Live Metrics Graphs](https://approov.io/docs/latest/approov-usage-documentation/#metrics-graphs). After you've run your app with Approov integration you should be able to see the results in the live metrics within a minute or so. At this stage you could even release your app to get details of your app population and the attributes of the devices they are running upon.
## NEXT STEPS
To actually protect your APIs and/or secrets there are some further steps. Approov provides two different options for protection:
* [API PROTECTION](https://github.com/approov/quickstart-flutter-httpclient/blob/master/API-PROTECTION.md): You should use this if you control the backend API(s) being protected and are able to modify them to ensure that a valid Approov token is being passed by the app. An [Approov Token](https://approov.io/docs/latest/approov-usage-documentation/#approov-tokens) is short lived crytographically signed JWT proving the authenticity of the call.
* [SECRETS PROTECTION](https://github.com/approov/quickstart-flutter-httpclient/blob/master/SECRETS-PROTECTION.md): This allows app secrets, including API keys for 3rd party services, to be protected so that they no longer need to be included in the released app code. These secrets are only made available to valid apps at runtime.
Note that it is possible to use both approaches side-by-side in the same app.
See [REFERENCE](https://github.com/approov/quickstart-flutter-httpclient/blob/master/REFERENCE.md) for a complete list of all of the `ApproovService` methods.