Giter Club home page Giter Club logo

react-native-ip-sec-vpn's Introduction

react-native-ip-sec-vpn

Getting started

Plugin can be installed using npm
With yarn:
$ yarn add react-native-ip-sec-vpn --save
Or with npm:
$ npm install react-native-ip-sec-vpn --save

Mostly automatic installation

on react native >60 no need to do anything but for manualing installation run the code below

$ react-native link react-native-ip-sec-vpn

Example

To run example:

  • make sure the module folder has no node_modules
  • install the dependencies on the example folder using yarn or npm i
  • run the project:
npx react-native run-android

Usage

import {prepare, connect} from "react-native-ip-sec-vpn";
...
useEffect(() => {
	prepare();
}); /// or use componentDidmount in case of a class component
...
connect(address, username, password)

see example folder.

Methods

Name arguments returns Description
prepare None Promise Android: This will ask permission and do necessary setups
IOS: This will listen for status change on vpn
connect address: string (address of VPN)
username: string (username of VPN's credentials)
password: string (username of VPN's credentials)
vpnType: string | undefined (Android only, not implemented yet)
mtu: number | undefiend (Android only, VPN's maximum transmission unit)
Promise Connect to vpn with provided credentials
getCurrentState None Promise Get current VPN state
getCharonErrorState (Android only) None Promise Get current VPN Error state (Android only)
disconnect None Promise Disconnect the VPN
onStateChangedListener callback: (state: { state: VpnState; charonState: CharonErrorState }) => void EmitterSubscription Will call the callback on state change
removeOnStateChangeListener stateChangedEvent: EmitterSubscription void Remove the state change listener

Enums

Name Values Description
VpnState disconnected = 0 (VPN is disconnected)
connecting = 1 (VPN is connecting)
connected = 2 (VPN is connected)
disconnecting = 3 (VPN is disconnecting)
genericError = 4 (VPN encountered an error charon state on android to find out the error)
VPN current state
CharonErrorState NO_ERROR = 0 (VPN has no error)
AUTH_FAILED = 1 (Wrong credentials)
PEER_AUTH_FAILED = 2
LOOKUP_FAILED = 3 (Wrong VPN URL)
UNREACHABLE = 4 (VPN URL is unreachable)
GENERIC_ERROR = 5
PASSWORD_MISSING = 6 (No password has been provided)
CERTIFICATE_UNAVAILABLE = 7 (Certification has not been provided)
UNDEFINED = 8 (Unknown error)
VPN Error

react-native-ip-sec-vpn's People

Contributors

sijav avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.