Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mk590901/authentication-with-toit

The repository contains an application in the Toit language that demonstrates adding records to the Firebase Realtime Database using authentication.
https://github.com/mk590901/authentication-with-toit

authentication http-client posting toit

Last synced: 4 months ago
JSON representation

The repository contains an application in the Toit language that demonstrates adding records to the Firebase Realtime Database using authentication.

Awesome Lists containing this project

README 

          
# Firebase Authentication with Toit



Below an application in the __Toit__ programming language that demonstrates adding records to the __Firebase Realtime Database__ using authentication via generated __ID Token__ (JWT).



## Introduction



The application uses the approach described earlier in the project https://github.com/mk590901/toit-rest-api-db, namely adding data to the cloud DB using __posting__. However, unlike the previous version, the current one uses the __Firebase authentication__ system. That is, this version of the application provides a more secure way to transfer and save data.



## Brief description



The application implements the standard Firebase method for relatively secure data transfer and storage:



* Obtaining an __ID Token__ via the __REST API__, using the __endpoint__ "https://identitytoolkit.googleapis.com/v1/accounts:signUp?key={your-api-key}" for anonymous authentication.

* Request body:

```

{

  "returnSecureToken": true

}

```

* Response:

```

{

  "idToken"      : "",

  "refreshToken" : "",

  "expiresIn"    : "3600",

  "localId"      : ""

}

```

* Sending data for writing using __endpoint__ "https://{your-project-id}-default-rtdb.firebaseio.com/{collection-name}.json?auth={idToken}"

* Request body is person information:

```

{

  "name"         : ,

  "surname"      : ,

  "e-mail"       : ,

  "phone"        : ,

  "age"          : 

}

```

* Response if success:

```

{

  name: 

}

```



### Issues



* __ID Token (JWT)__ is the primary token that is used to authenticate requests to __Firebase__ (e.g. in the REST API to add records to the database). It contains user information and has a limited lifetime of 1 hour (3600 seconds). After expiration, it becomes invalid and Firebase will return an error (e.g. "ID token has expired").



* __Refresh Token__ is a long-lived token that does not automatically expire after an hour. It is intended specifically for refreshing the __ID Token__. Refresh token may be invalidated only in rare cases: if the user explicitly logged out of the account, if the account was disabled, if suspicious changes were detected (e.g. password or email change), or if the token was revoked by the administrator. In a typical scenario, a refresh token lives for weeks, months, or even longer as long as the user is active.



* The need to change the token will be detected the next time a user is added. You will receive a 401: __UNAUTHORIZED ACCESS__ error. In this case, you need to request a new token and repeat the user addition operation.



* You can refresh the token on request by sending a __POST__ request to the endpoint https://securetoken.googleapis.com/v1/token?key={your-api-key} with the body:

```

{

  "grant_type"    : "refresh_token",

  "refresh_token" : ""

}

```



* Response:

* 

```

{

  "access_token"  : "",

  "expires_in"    : "3600",

  "token_type"    : "Bearer",

  "refresh_token" : "",

  "user_id"       : ""

}

```



## Implementation



The presented application implements the approaches described above:



> Function __get_tokens__ :

* Sends a POST request to the Firebase Authentication and return __Map?__ with the __id_token__ and __refresh_token__ fields extracted from the response.

* Returns null if the request fails or an error occurs.



> Function __refresh_id_token__ :

* Returns __Map?__ with the id_token and refresh_token fields or null if the request failed.



> Function __create_user__ :

* Returns the current refresh_token (or a new one if it was updated) so that it can be used in the future.

* On error 401 (__UNAUTHORIZED ACCESS__), calls __refresh_id_token__ and, if a new __id_token__ and __refresh_token__ are received, it updates the global variables.

* Repeats the request with the new __id_token__.



## Preparation of Firebase Realtime Database via Firebase Console



> Get API Key



* Select your project.

* Go to __Project Settings__ (gear icon in the upper left corner ➜ __Project settings__).

* In the __General tab__, scroll down to the apps section.

* If you don't have an app registered, add a web (or Android) app.

* Click __Add app__ ➜ select a web app (icon >).

* Register your app and extract the __API__ Key from the configuration.



> Set up security rules



* To use the __API key__, set up security rules in Firebase Realtime Database (in the Realtime Database ➜ Rules section). Example of rules allowing access with an API key:

```

{

  "rules": {

    "users": {

      ".read": "auth != null",

      ".write": "auth != null"

    }

  }

}

```

> To use __Firebase Authentication__ to generate an ID Token (JWT), you need to enable authentication for __Firebase Realtime Database__ settings:

* In the __Firebase Console__, go to __Authentication__ ➜ Sign-in method.

* Enable at least one sign-in method, such as __Anonymous__ (for simplicity) or __Email/Password__. In this case, __Anonymous__ is selected.



## Application management



> Installing packages:



* __http__

```

$ jag pkg install github.com/toitlang/pkg-http@v2

```

* __certificate-roots__

```

$ jag pkg install github.com/toitware/toit-cert-roots@v1

```



> Loading the application



```

micrcx@micrcx-desktop:~/toit/person$ jag run -d midi users.toit

Scanning for device with name: 'midi'

Running 'users.toit' on 'midi' ...

Success: Sent 119KB code to 'midi' in 3.35s

micrcx@micrcx-desktop:~/toit/person$ 

```



> Monitoring

```

micrcx@micrcx-desktop:~/toit/person$ jag monitor -p /dev/ttyACM1

Starting serial monitor of port '/dev/ttyACM1' ...

ESP-ROM:esp32s3-20210327

Build:Mar 27 2021

rst:0x15 (USB_UART_CHIP_RESET),boot:0x8 (SPI_FAST_FLASH_BOOT)

Saved PC:0x40385b12

SPIWP:0xee

mode:DIO, clock div:1

load:0x3fce2810,len:0xdc

load:0x403c8700,len:0x4

load:0x403c8704,len:0xa08

load:0x403cb700,len:0x257c

entry 0x403c8854

[toit] INFO: starting 

[toit] DEBUG: clearing RTC memory: powered on by hardware source

[toit] INFO: running on ESP32S3 - revision 0.2

[toit] INFO: using SPIRAM for heap metadata and heap

[wifi] DEBUG: connecting

E (4007) wifi:Association refused too many times, max allowed 1

[wifi] WARN: connect failed {reason: unknown reason (208)}

[wifi] DEBUG: closing

[jaguar] WARN: running Jaguar failed due to 'CONNECT_FAILED: unknown reason (208)' (1/3)

[wifi] DEBUG: connecting

E (6777) wifi:Association refused too many times, max allowed 1

[wifi] WARN: connect failed {reason: unknown reason (208)}

[wifi] DEBUG: closing

[jaguar] WARN: running Jaguar failed due to 'CONNECT_FAILED: unknown reason (208)' (2/3)

[wifi] DEBUG: connecting

[wifi] DEBUG: connected

[wifi] INFO: network address dynamically assigned through dhcp {ip: 192.168.1.147}

[wifi] INFO: dns server address dynamically assigned through dhcp {ip: [192.168.1.1]}

[jaguar.http] INFO: running Jaguar device 'midi' (id: '1429cbbc-ca45-4c11-88ee-9500a1c318dc') on 'http://192.168.1.147:9000'

[jaguar] INFO: program 322d4e71-e169-757b-c0e7-fdbceb243d48 started

Obtaining ID Token and Refresh Token ...

Tokens successfully received

*** id_token->

eyJhbGciOiJSUzI1NiIsImtpZCI6ImUzZWU3ZTAyOGUzODg1YTM0NWNlMDcwNTVmODQ2ODYyMjU1YTcwNDYiLCJ0eXAiOiJKV1QifQ.eyJwcm92aWRlcl9pZCI6ImFub255bW91cyIsImlzcyI6Imh0dHBzOi8vc2VjdXJldG9rZW4uZ29vZ2xlLmNvbS9hdXRoLTJiN2QzIiwiYXVkIjoiYXV0aC0yYjdkMyIsImF1dGhfdGltZSI6MTc1NzUwNDA3NSwidXNlcl9pZCI6Ik95dnRQTWRHa2RVUWZPU1l0aW9GN1FnOVlMTzIiLCJzdWIiOiJPeXZ0UE1kR2tkVVFmT1NZdGlvRjdRZzlZTE8yIiwiaWF0IjoxNzU3NTA0MDc1LCJleHAiOjE3NTc1MDc2NzUsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnt9LCJzaWduX2luX3Byb3ZpZGVyIjoiYW5vbnltb3VzIn19.Py_BNzkcqh0hkfY3ZCXq8KTk9IyjXAXx6vH4aEcmNKActR3CLWA9HE7rcLOV2mYLbh9d5JKZ7s2V7sBjAcD0Da6E6BajpL7cxbEA2EFAELb_-w2wct1kGz0J0NIAVDFDg4-AA-QR6IWM8jkYOisGLX5L-X8DtT8yq_-yVSBWD_7OWvucscEjYL2uFAeEHMBtz-bmEq5HcH7jOwZJBWC2ijLV4FVwO59_edFK5H8z5eEs6I9SvDMloMc_BY3Afg2GlFj47ADoAFHUEt9UAWkETdcqcxlKGCuYgPnelU1QyykKJVTjV5m2UXbXFVP1ro-fBdqr1EKo_WuoaZXGnq3E3w

*** refresh_token->

AMf-vBzNzokHLNP5eq1Xz6I-tlVqpfYaowXOP82CmmysS8rzG3aUN6v47ZBJ8tolQExfO74HFmBHCZ5L71RW2dFkLys9xVqWJDmctYMpz5_ymMt1nWCBG5F_0peQrV9e3Wh3x0UR8vedLtbn03EcfejsVRUuLBDTiowCSML4L_Z6wMuvOzxhI5o

Sending a POST request to https://auth-2b7d3-default-rtdb.firebaseio.com/users.json

User was created {name: -OZnOzkVaPFkgWO1vC6A}

Sending a POST request to https://auth-2b7d3-default-rtdb.firebaseio.com/users.json

User was created {name: -OZnP-44o5sHZX2xqlE0}

Sending a POST request to https://auth-2b7d3-default-rtdb.firebaseio.com/users.json

User was created {name: -OZnP-QCNogGEv8m7NSR}

[jaguar] INFO: program 322d4e71-e169-757b-c0e7-fdbceb243d48 stopped



```



## Movie



[users2.webm](https://github.com/user-attachments/assets/c20f33bd-f3dc-43e6-a6b4-a432512a929e)