1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
|
// Copyright 2015 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package idptest
import (
"bytes"
"context"
"crypto/sha256"
"encoding/base64"
"html/template"
"io/ioutil"
"net/http"
"net/http/cookiejar"
"net/http/httptest"
"net/url"
"strings"
"time"
qt "github.com/frankban/quicktest"
"github.com/go-macaroon-bakery/macaroon-bakery/v3/bakery"
"github.com/go-macaroon-bakery/macaroon-bakery/v3/httpbakery"
"github.com/juju/qthttptest"
"github.com/juju/simplekv"
errgo "gopkg.in/errgo.v1"
"github.com/canonical/candid/idp"
"github.com/canonical/candid/idp/idputil"
"github.com/canonical/candid/idp/idputil/secret"
"github.com/canonical/candid/internal/candidtest"
"github.com/canonical/candid/params"
"github.com/canonical/candid/store"
)
// Fixture provides a test fixture that is helpful for testing identity
// providers.
type Fixture struct {
// Ctx holds a context appropriate for using
// for store methods.
Ctx context.Context
// Codec contains a codec that will be passed in the idp.InitParams.
Codec *secret.Codec
// Oven contains a bakery.Oven that will be passed in the
// idp.InitParams. Tests can use this to mint macaroons if
// necessary.
Oven *bakery.Oven
// Store holds the store used by the fixture.
Store *candidtest.Store
// Template holds the template to use for generating pages
Template *template.Template
dischargeTokenCreator *dischargeTokenCreator
visitCompleter *visitCompleter
kvStore simplekv.Store
}
func NewFixture(c *qt.C, store *candidtest.Store) *Fixture {
ctx, closeStore := store.Store.Context(context.Background())
c.Cleanup(closeStore)
ctx, closeMeetingStore := store.MeetingStore.Context(ctx)
c.Cleanup(closeMeetingStore)
key, err := bakery.GenerateKey()
c.Assert(err, qt.IsNil)
oven := bakery.NewOven(bakery.OvenParams{
Key: key,
Location: "idptest",
})
kv, err := store.ProviderDataStore.KeyValueStore(ctx, "idptest")
c.Assert(err, qt.IsNil)
return &Fixture{
Ctx: ctx,
Codec: secret.NewCodec(key),
Oven: oven,
Store: store,
Template: candidtest.DefaultTemplate,
dischargeTokenCreator: &dischargeTokenCreator{},
visitCompleter: &visitCompleter{
c: c,
},
kvStore: kv,
}
}
// InitParams returns a completed InitParams that a test can use to pass
// to idp.Init.
func (s *Fixture) InitParams(c *qt.C, prefix string) idp.InitParams {
return idp.InitParams{
Store: s.Store.Store,
KeyValueStore: s.kvStore,
Oven: s.Oven,
Codec: s.Codec,
URLPrefix: prefix,
DischargeTokenCreator: s.dischargeTokenCreator,
VisitCompleter: s.visitCompleter,
Template: s.Template,
}
}
// LoginState creates a candid-login with the given login state.
func (s *Fixture) LoginState(c *qt.C, state idputil.LoginState) (*http.Cookie, string) {
value, err := s.Codec.Encode(state)
c.Assert(err, qt.IsNil)
rawValue, err := base64.URLEncoding.DecodeString(value)
c.Assert(err, qt.IsNil)
hash := sha256.Sum256(rawValue)
return &http.Cookie{
Name: idputil.LoginCookieName,
Value: value,
}, base64.RawURLEncoding.EncodeToString(hash[:])
}
// Client creates an HTTP client that will replace the given prefix with
// the given replacement in all request URLs. The client will also stop
// redirecting and return the last response when a request with the given
// stopPrefix is attempted.
func (s *Fixture) Client(c *qt.C, prefix, replacement, stopPrefix string) *http.Client {
jar, err := cookiejar.New(nil)
c.Assert(err, qt.IsNil)
return &http.Client{
Transport: qthttptest.URLRewritingTransport{
MatchPrefix: prefix,
Replace: replacement,
RoundTripper: http.DefaultTransport,
},
CheckRedirect: func(req *http.Request, via []*http.Request) error {
if strings.HasPrefix(req.URL.String(), stopPrefix) {
return http.ErrUseLastResponse
}
return nil
},
Jar: jar,
}
}
// ParseResponse parses a store.Identity from the given HTTP response.
func (s *Fixture) ParseResponse(c *qt.C, resp *http.Response) (*store.Identity, error) {
switch resp.StatusCode {
case http.StatusOK:
buf, err := ioutil.ReadAll(resp.Body)
c.Assert(err, qt.IsNil)
parts := bytes.Split(buf, []byte("\n"))
if len(parts) > 1 && len(parts[1]) > 0 {
return nil, errgo.New(string(parts[1]))
}
case http.StatusSeeOther:
ru, err := url.Parse(resp.Header.Get("Location"))
c.Assert(err, qt.IsNil)
rv := ru.Query()
if msg := rv.Get("error"); msg != "" {
if code := rv.Get("error_code"); code != "" {
return nil, errgo.WithCausef(nil, params.ErrorCode(code), "%s", msg)
}
return nil, errgo.New(msg)
}
c.Assert(rv.Get("code"), qt.Equals, "6789")
return s.visitCompleter.id, nil
default:
c.Fatalf("unexpected response type: %s", resp.Status)
}
return nil, nil
}
// DoInteractiveLogin performs a full interactive login cycle with the
// given IDP.
func (s *Fixture) DoInteractiveLogin(c *qt.C, idp idp.IdentityProvider, loginURL string, f func(*http.Client, *http.Response) (*http.Response, error)) (*store.Identity, error) {
u, err := url.Parse(loginURL)
c.Assert(err, qt.IsNil)
hu := *u
hu.Path = ""
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
req.ParseForm()
idp.Handle(req.Context(), w, req)
}))
defer srv.Close()
client := s.Client(c, hu.String(), srv.URL, "http://result.example.com")
cookie, state := s.LoginState(c, idputil.LoginState{
ReturnTo: "http://result.example.com/callback",
State: "1234",
Expires: time.Now().Add(10 * time.Minute),
})
client.Jar.SetCookies(&hu, []*http.Cookie{cookie})
v := u.Query()
v.Set("state", state)
u.RawQuery = v.Encode()
resp, err := client.Get(u.String())
c.Assert(err, qt.IsNil)
if f != nil {
resp, err = f(client, resp)
c.Assert(err, qt.IsNil)
}
defer resp.Body.Close()
return s.ParseResponse(c, resp)
}
// AssertLoginSuccess asserts that the login test has resulted in a
// successful login of the given user.
func (s *Fixture) AssertLoginSuccess(c *qt.C, username string) {
c.Assert(s.visitCompleter.called, qt.Equals, true)
c.Check(s.visitCompleter.err, qt.Equals, nil)
c.Assert(s.visitCompleter.id, qt.Not(qt.IsNil))
c.Assert(s.visitCompleter.id.Username, qt.Equals, username)
}
// AssertLoginRedirectSuccess asserts that the given redirect URL is for
// a successful login of the given user.
func (s *Fixture) AssertLoginRedirectSuccess(c *qt.C, rurl, returnTo, state string, username string) {
u, err := url.Parse(rurl)
c.Assert(err, qt.IsNil)
v := u.Query()
u.RawQuery = ""
c.Assert(u.String(), qt.Equals, returnTo)
c.Assert(v.Get("state"), qt.Equals, state)
c.Assert(v.Get("code"), qt.Equals, "6789")
c.Assert(s.visitCompleter.id.Username, qt.Equals, username)
}
// AssertLoginFailureMatches asserts that the login test has resulted in a
// failure with an error that matches the given regex.
func (s *Fixture) AssertLoginFailureMatches(c *qt.C, regex string) {
c.Assert(s.visitCompleter.called, qt.Equals, true)
c.Assert(s.visitCompleter.err, qt.ErrorMatches, regex)
}
// AssertLoginRedirectFailureMatches asserts that the login test has resulted in a
// failure with an error that matches the given regex.
func (s *Fixture) AssertLoginRedirectFailureMatches(c *qt.C, rurl, returnTo, state, errorCode, regex string) {
u, err := url.Parse(rurl)
c.Assert(err, qt.IsNil)
v := u.Query()
u.RawQuery = ""
c.Assert(u.String(), qt.Equals, returnTo)
c.Assert(v.Get("state"), qt.Equals, state)
c.Assert(v.Get("error_code"), qt.Equals, errorCode)
c.Assert(v.Get("error"), qt.ErrorMatches, regex)
}
// AssertLoginNotComplete asserts that the login attempt has not yet
// completed.
func (s *Fixture) AssertLoginNotComplete(c *qt.C) {
c.Assert(s.visitCompleter.called, qt.Equals, false)
}
type visitCompleter struct {
c *qt.C
called bool
dischargeID string
id *store.Identity
err error
}
func (l *visitCompleter) Success(_ context.Context, _ http.ResponseWriter, _ *http.Request, dischargeID string, id *store.Identity) {
if l.called {
l.c.Error("login completion method called more than once")
return
}
l.called = true
l.dischargeID = dischargeID
l.id = id
}
func (l *visitCompleter) Failure(_ context.Context, _ http.ResponseWriter, _ *http.Request, dischargeID string, err error) {
if l.called {
l.c.Error("login completion method called more than once")
return
}
l.called = true
l.dischargeID = dischargeID
l.err = err
}
// RedirectSuccess implements isp.VisitCompleter.RedirectSuccess.
func (l *visitCompleter) RedirectSuccess(_ context.Context, w http.ResponseWriter, req *http.Request, returnTo, state string, id *store.Identity) {
if l.called {
l.c.Error("login completion method called more than once")
return
}
l.id = id
u, err := url.Parse(returnTo)
if err != nil {
l.c.Error(err)
return
}
v := u.Query()
v.Set("state", state)
v.Set("code", "6789")
u.RawQuery = v.Encode()
http.Redirect(w, req, u.String(), http.StatusSeeOther)
}
// RedirectFailure implements isp.VisitCompleter.RedirectFailure.
func (l *visitCompleter) RedirectFailure(_ context.Context, w http.ResponseWriter, req *http.Request, returnTo, state string, verr error) {
if l.called {
l.c.Error("login completion method called more than once")
return
}
l.called = true
u, err := url.Parse(returnTo)
if err != nil {
l.c.Error(err)
return
}
v := u.Query()
v.Set("state", state)
v.Set("error", verr.Error())
if ec, ok := errgo.Cause(verr).(errorCoder); ok {
v.Set("error_code", string(ec.ErrorCode()))
}
u.RawQuery = v.Encode()
http.Redirect(w, req, u.String(), http.StatusSeeOther)
}
func (l *visitCompleter) RedirectMFA(ctx context.Context, w http.ResponseWriter, req *http.Request, requireMFA bool, returnTo, returnToState, state string, id *store.Identity) {
// NOTE: mfa is currently not tested via unit-tests.
l.RedirectSuccess(ctx, w, req, returnTo, returnToState, id)
}
func (f *Fixture) Reset() {
f.visitCompleter.called = false
f.visitCompleter.dischargeID = ""
f.visitCompleter.id = nil
f.visitCompleter.err = nil
}
type errorCoder interface {
ErrorCode() params.ErrorCode
}
type dischargeTokenCreator struct{}
func (d *dischargeTokenCreator) DischargeToken(_ context.Context, id *store.Identity) (*httpbakery.DischargeToken, error) {
return &httpbakery.DischargeToken{
Kind: "test",
Value: []byte(id.Username),
}, nil
}
|