2.0.111 • Published 12 months ago

oauth-electron v2.0.111

Weekly downloads
3
License
-
Repository
github
Last release
12 months ago

drawing 1

Build Status codecov npm GitHub license Maintenance Donate

Use OAuth in a simple way inside your electron App.

Installation

add it to your electron project using npm install oauth-electron --save or yarn add oauth-electron

Usage

require oauth-electron exports a function that requires a javascript object and an electron window, as seen on the next example:

Oauth1

const login = require(`oauth-electron`)

let info = {
    key: ***,
    secret: ***,
    accessUrl: ***,
    authenticateUrl: ***,
    version: ***,
    authCallback: ***,
    signatureMethod: ***,
},
window = new BrowserWindow({webPreferences: {nodeIntegration: false}});

login.oauth1(info, window)

the login function will return a Promise with the access token and secret

{
    token: ***,
    tokenSecret: ***
}

Oauth2

const login = require('oauth-electron')
const { BrowserWindow, session } = require('electron')

let info = {
    key: ***,
    secret: ***,
    scope: ***,
    baseSite: ***,
    authorizePath: ***,
    accessTokenPath: ***,
    redirectUrl: ***,
    responseType: ***, //this is optional if not provided it will default to 'code'
},
window = new BrowserWindow({webPreferences: {nodeIntegration: false}});

login.oauth2(info, window, session)

the login function will return a Promise with the access token and secret

{
    accessToken: ***,
    refreshToken?: ***,
    <others: ***>
}

Security

Consider this before you integrate this library in your application:

  • It is a bad practice to hardcode keys & secrets in code that is going to be shipped.
  • If you are looking to have your own backend, consider using it for authentication with 3rd party services. IETF RFC 8252.

Migration V1.x to V2.x

  • Please refer to the response of the service, as there will probably be extra fields in the response
  • session is required to be passed as events of chromium have changed

Migration V0.x to V1.x

  • there is no more need for the oauth object, info becomes a basic object with the properties stated in the usage step.
  • the return object has a different format.
logo: Award,Passport graphics by Freepik from Flaticon are licensed under CC BY 3.0. Made with Logo Maker
2.0.111

12 months ago

2.0.109

1 year ago

2.0.110

1 year ago

2.0.108

1 year ago

2.0.107

1 year ago

2.0.106

1 year ago

2.0.105

1 year ago

2.0.104

1 year ago

2.0.103

1 year ago

2.0.102

1 year ago

2.0.101

1 year ago

2.0.100

1 year ago

2.0.99

1 year ago

2.0.97

1 year ago

2.0.98

1 year ago

2.0.96

1 year ago

2.0.95

1 year ago

2.0.94

1 year ago

2.0.93

1 year ago

2.0.92

1 year ago

2.0.91

1 year ago

2.0.90

1 year ago

2.0.89

1 year ago

2.0.88

1 year ago

2.0.87

1 year ago

2.0.86

1 year ago

2.0.85

2 years ago

2.0.84

2 years ago

2.0.83

2 years ago

2.0.82

2 years ago

2.0.81

2 years ago

2.0.80

2 years ago

2.0.79

2 years ago

2.0.78

2 years ago

2.0.77

2 years ago

2.0.76

2 years ago

2.0.75

2 years ago

2.0.74

2 years ago

2.0.68

2 years ago

2.0.69

2 years ago

2.0.66

2 years ago

2.0.67

2 years ago

2.0.64

2 years ago

2.0.65

2 years ago

2.0.73

2 years ago

2.0.71

2 years ago

2.0.72

2 years ago

2.0.70

2 years ago

2.0.62

2 years ago

2.0.63

2 years ago

2.0.49

2 years ago

2.0.59

2 years ago

2.0.57

2 years ago

2.0.58

2 years ago

2.0.55

2 years ago

2.0.56

2 years ago

2.0.53

2 years ago

2.0.54

2 years ago

2.0.51

2 years ago

2.0.52

2 years ago

2.0.50

2 years ago

2.0.60

2 years ago

2.0.61

2 years ago

2.0.48

2 years ago

2.0.47

2 years ago

2.0.37

3 years ago

2.0.38

3 years ago

2.0.35

3 years ago

2.0.36

3 years ago

2.0.34

3 years ago

2.0.39

3 years ago

2.0.46

2 years ago

2.0.44

2 years ago

2.0.45

2 years ago

2.0.42

2 years ago

2.0.43

2 years ago

2.0.40

3 years ago

2.0.41

2 years ago

2.0.28

3 years ago

2.0.29

3 years ago

2.0.33

3 years ago

2.0.31

3 years ago

2.0.32

3 years ago

2.0.30

3 years ago

2.0.26

3 years ago

2.0.27

3 years ago

2.0.24

3 years ago

2.0.25

3 years ago

2.0.22

3 years ago

2.0.23

3 years ago

2.0.20

3 years ago

2.0.21

3 years ago

2.0.15

3 years ago

2.0.16

3 years ago

2.0.14

3 years ago

2.0.19

3 years ago

2.0.17

3 years ago

2.0.18

3 years ago

2.0.13

3 years ago

2.0.11

3 years ago

2.0.12

3 years ago

2.0.9

3 years ago

2.0.10

3 years ago

2.0.8

6 years ago

2.0.7

6 years ago

2.0.6

6 years ago

2.0.5

6 years ago

2.0.4

6 years ago

2.0.3

6 years ago

2.0.2

6 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.1.12

7 years ago

1.1.11

7 years ago

1.1.10

7 years ago

1.1.9

7 years ago

1.1.8

7 years ago

1.1.7

7 years ago

1.1.6

7 years ago

1.1.5

7 years ago

1.1.4

7 years ago

1.1.3

7 years ago

1.1.2

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.13

7 years ago

1.0.12

7 years ago

1.0.11

7 years ago

1.0.10

7 years ago

1.0.9

7 years ago

1.0.8

7 years ago

1.0.7

7 years ago

1.0.6

7 years ago

1.0.5

7 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

0.1.1

7 years ago

1.0.0

7 years ago

0.1.0

9 years ago