koa-passport/CHANGELOG.md

Passport middleware for Koa

# Changelog

## 6.0.0

Potentially breaking change:

- change `logout` signature from `(options, callback) => void` to `(options) => Promise<void>` #188

## 5.0.0

- upgrade `passport` to 0.6

## 4.1.4

- add `ip` to the Koa `ctx` delegates #157

## 4.1.3

- add `set` to `req` to imporve compatibility with more passport strategies #128

## 4.1.1

- add `protocol` to the Koa `ctx` delegates #121

## 4.1.0

- add `res` to `req` #114
- add `send()` method to `req` #114

## 4.0.1

- add `params` to `req` #110

## 4.0.0

- upgrade `passport` to 0.4
- add `ctx` getter to `req` #89

## 3.0.0

- remove `ctx.passport` and save state variables (like `_passport` and `user`) in `ctx.state` instead
- prevent `passport` from monkey patching `http.IncomingMessage`
- change arguments from custom authentication callbacks from `user, info, status` to `err, user, info, status` (`err` added) to be consistent with passport
- add support for `assignProperty` option (#86)

## 2.2.2

- remove `ctx.req.user` deprecation warning for now #66

## 2.2.1

- fix middleware to properly catch promise errors #63

## 2.2.0

- move `user` into `ctx.state`
- user in `ctx.req.user` is deprecated and will removed eventually

## 2.1.0

- export KoaPassport as an alternative to the by default exported singleton

## 2.0.1

- use strict

## 2.0.0

- use promises rather than generators for `koa@2.x` compatibility
- use some es6 features

## 1.3.0

- export KoaPassport as an alternative to the by default exported singleton

## 1.2.0

- upgrade `passport` to `^0.3.0`

## 1.1.5

- fix to not throw if `req.user` is already defined
- upgrade dependencies

## 1.1.4

- add `status` argument to authentication callback

## 1.1.3

- make internal `req` mock less error-prone

## 1.1.2

- redirect `req.app.get('trust proxy')` to Koa's `app.proxy` (#22)

## 1.1.1

- add `authInfo` to request mock

## 1.1.0

Make the `req` mock to inherit from Koa's `request` object before adding delegates for Node's request and Koa's context to it. This makes custom properties/methods added to Koa's request available to passport and its authentication strategies.

## 1.0.1

- add `flash` to the `req` mock

## 1.0.0

Using ES6 Proxy currently breaks debugging (see #17). Until this is fixed, the Proxy approach got replace by delegating a whitelist of possible used properties/methods to either Node's request, Koa's context or Koa's request.

Note: There is nothing special about this being `1.0.0`. The major version bump is just because the update could possible break something.

## 0.5.1

- re-add authenticated user to `req.user`

## 0.5.0

- internal improvements (neither modify Node's request nor Koa's request object by mocking the `req` object with a proxy that forwards reads to either Node's request object, Koa's request object or Koa's context)
- `--harmony-proxies` has to enabled now

## 0.4.0

- Add support for custom authentication methods, e.g.:

```js
public.post('/login', function*(next) {
  var ctx = this
  yield* passport.authenticate('local', function*(err, user, info) {
    if (err) throw err
    if (user === false) {
      ctx.status = 401
      ctx.body = { success: false }
    } else {
      yield ctx.login(user)
      ctx.body = { success: true }
    }
  }).call(this, next)
})
```

## 0.3.2

- add generator function names for Koa debugging purposes

## 0.3.1

- make ctx.login() yieldable

## 0.3.0

- adapt recent Koa API changes

## 0.2.0

- `passport 0.2.x compatibility