nicolassiver / nodebb-plugin-ns-login Goto Github PK

View Code? Open in Web Editor NEW

21.0 6.0 17.0 26 KB

External login check for your NodeBB.

License: MIT License

JavaScript 100.00%

nodebb authorization login plugin

nodebb-plugin-ns-login's Introduction

NodeBB: Simple Login

Simple API endpoint for external login. Special use case: external login check if user's credentials are valid.

API

Plugin adds additional API endpoint.

[POST] https://YourBoardDomain.com/api/ns/login

Properties:

username [String] - Required field. It could be username or email. It uses internal NodeBB methods to resolve.
password [String] - Required field.

Result:

Successful login returns user data, it looks like:

{
"_key": "user:1",
"username": "Nicolas",
"userslug": "nicolas",
"email": "[email protected]",
"email:confirmed": 1,
"joindate": 1432379229517,
"picture": "https://secure.gravatar.com/avatar/16e774e25b68ab1d41d2cc269a29983a?size=128&default=identicon&rating=pg",
"gravatarpicture": "https://secure.gravatar.com/avatar/16e774e25b68ab1d41d2cc269a29983a?size=128&default=identicon&rating=pg",
"fullname": "",
"location": "",
"birthday": "",
"website": "",
"signature": "",
"uploadedpicture": "",
"profileviews": 0,
"reputation": 0,
"postcount": 0,
"topiccount": 0,
"lastposttime": 0,
"banned": 0,
"status": "online",
"uid": 1,
"passwordExpiry": 0,
"lastonline": 1432379559871
}

Using plugin as internal REST API

Whenever used as internal API disable IP limiter in userDefence instance of express-brute.

userDefence.getMiddleware({
    // Disregard IP address when matching requests if set to true
    // Set true if API is used internaly from few IPs
    ignoreIP: true, 
    key: function (req, res, next) {
        // prevent too many attempts for the same username
        next(req.body.username);
    }
})

Additional information

It is simple
It has brute-force defence. The brute-force counter resets on successful login.

nodebb-plugin-ns-login's People

Contributors

Stargazers

Watchers

Forkers

michaelermer cloudxtreme rudimk acanguven ayxos samt2497 ilblog martindolecek kunjun roundtablestudio magictea-intl mdorda barisusakli glorialai nyoub windycom

nodebb-plugin-ns-login's Issues

Return email validity

Hi, I think your plugin could use a small improvement...
When logged in correctly, the returned JSON should also return wether or not the email was validated - In order to check if the user is just a troll...
Thanks in advance!

Using this to integrate with Rocket Chat

Hi @NicolasSiver.

This isn't an issue but a question perhaps.

Do you think it is possible to use this plugin to let users on Rocket Chat sign in using https://rocket.chat/docs/developer-guides/iframe-integration/authentication/#what-is-iframe-auth

Returns 404 ?

https://kbve.com/api/ns/login

Returns a 404 , specifically
"{"path":"/ns/login","title":"[[global:404.title]]"}"

Can't login using email - Intended or not?

The "username input" is slugified immediately without checking if this provided string is an email adress...
Your description states, that logging in via email should be possible...
Either you should change your README, or re-implement this feature since it seems to be broken...

Also, please change this line to 'User ' + username + ' does not exist'

Not working with 1.13.1

i guess the routing is not working the same way as before in 1.13.1.
When calling the api route it says not found.

Can't Access the API

I've installed this on the latest NodeBB and I can't access the API from domain.com/api/ns/login -> I get a 404 not found.. Any ideas?

NodeBB v1.11.x compatibility

When trying to run the plugin with NodeBB v1.11.1 it throws the error:

Error: Cannot find module './src/emitter'

no sessions

I am using nodebb for the community section in another app.

I want user to be logged in when he logs into my app. I simultaneously log in using ns-login but if I visit the forum address on the same browser, the user is not logged in.

I checked the res.body and status is offline even after signing me in. How do I resolve this issue?