autodroid sdk

AutoDroid SDK

---

Index

• On
• Before you start
• ???‍ Usage
• Project Overview
• ⛏️ Technologies Used
• ?? Contributions
• ? Changelog
• References

On

This project starts from the need to offer the DroidAugmentor and MalSynGen tool as a service, as presented in AutoDroid.

This SDK was developed to facilitate the integration and development of applications that want to connect with the AutoDroid API.

Access the AutoDroid API application repository for more information about the project and the necessary configurations before using this library.

The project can also be used through this Postman collection.

Discover the Malware Datalab project!

Before you start

The application backend uses Firebase for user authentication and authorization. To use the application, it is necessary to create a project in Firebase and configure access credentials, as in Firebase.

???‍ Usage

Install this library using your favorite package manager:

yarn add autodroid
# ou
npm install autodroid
# ou
pnpm install autodroid

Once Firebase is configured, you can use the library to connect with the AutoDroid API:

 import { AutoDroidSdk } from "autodroid" ;

const autoDroid = new AutoDroidSdk ( {
  baseUrl : "https://mdl-api.unihacker.club/graphql" ,

  getAuthToken : async ( ) => {
    const token = ( await firebaseAuth . currentUser ?. getIdToken ( ) ) || "" ;
    return token ;
  } ,

  onAuthError : ( ) => {
    // OPTIONAL: add your logic here for Authentication Error
  } ,

  onGraphQLError : error => {
    // OPTIONAL: add your logic here for GraphQL Errors
  } ,

  onNetworkError : error => {
    // OPTIONAL: add your logic here for Network Errors
  } ,
} ) ;

export { autoDroid } ;

Use the autoDroid instance to perform the operations available in the API, such as:

 import { autoDroid } from "./api" ;

const start = async ( ) => {
  const response = await autoDroid . processing . requestDatasetProcessing ( {
    data : {
      dataset_id : "..." ,
      processor_id : "..." ,
      parameters : [
        {
          name : "training_algorithm" ,
          value : "RandomForest,SupportVectorMachine,DecisionTree" ,
        } ,
        {
          name : "number_epochs" ,
          value : "100" ,
        } ,
      ] ,
    } ,
  } ) ;

  console . log ( response . status ) ;
} ;

start ( ) ; 

Project Overview

The API is inserted in the context of the AutoDroid project, which is an application that aims to offer the DroidAugmentor/MalSynGen tool as a service.

⛏️ Technologies Used

• TypeScript - Programming language
• Node.js - Execution environment
• Apollo Client - GraphQL Client
• GraphQL Codegen - GraphQL code generator
• Yarn - Package Manager

General

It is important to mention the other tools that will be used in both parts of the project:

• Git - Version Control
• Husky - Git Hooks
• Lint Staged - Tool to check committed files
• Commitizen - Helper for Git commit messages
• Commitlint - Git commit message checker
• Standard Version - Changelog generator
• Eslint - Code Checking Framework
• Prettier - Code Formatter
• Semver - Semantic versioning

References

LAVIOLA, Luiz Felipe; PAIM, Kayuã Oleques; KREUTZ, Diego; MANSILHA, Rodrigo Brandão. AutoDroid: making the DroidAugmentor tool available as a service. In: ESCOLA REGIONAL DE RETES DE COMPUTADORES (ERRC), 20. , 2023, Porto Alegre/RS. Annals [...]. Porto Alegre: Brazilian Computing Society, 2023 . p. 145-150. DOI: https://doi.org/10.5753/errc.2023.929.