hoernschen/dendrite
1
0
Fork 0
mirror of https://github.com/hoernschen/dendrite.git synced 2024-12-27 07:28:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Modify comments

Browse source
This commit is contained in:
Andrew Morgan 2018-07-12 15:46:45 +01:00
parent b020ac80da
commit 604bf0288a
2 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/github.com/matrix-org/dendrite/clientapi/routing/user_interactive_auth_flow.go
View file

@ -1,5 +1,4 @@
// Copyright 2017 Vector Creations Ltd // Copyright 2018 New Vector Ltd
// Copyright 2017 New Vector Ltd
// //
// Licensed under the Apache License, Version 2.0 (the "License"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -166,11 +165,11 @@ func validateRecaptcha(
} }
// HandleUserInteractiveFlow will direct and complete UIAA flow stages that the client has requested. // HandleUserInteractiveFlow will direct and complete UIAA flow stages that the client has requested.
// It accepts a pointer to http request, an interface of type UserInteractiveFlowRequest, config, // It accepts a pointer to a http request, an interface of type UserInteractiveFlowRequest, config,
// sessionID and a list of required stages to complete the flow as config.UserInteractiveAuthConfig // sessionID and a list of required stages to complete the flow as config.UserInteractiveAuthConfig
// and returns UserInteractiveResponse as specified in // and returns UserInteractiveResponse as specified in
// https://matrix.org/docs/spec/client_server/r0.3.0.html#user-interactive-authentication-api // https://matrix.org/docs/spec/client_server/r0.3.0.html#user-interactive-authentication-api
// The function returns nil if authenticated successfully. // This function returns nil if authentication was successful.
func HandleUserInteractiveFlow( func HandleUserInteractiveFlow(
req *http.Request, req *http.Request,
r UserInteractiveFlowRequest, r UserInteractiveFlowRequest,

6
src/github.com/matrix-org/dendrite/common/config/config.go
View file

@ -241,8 +241,10 @@ type Dendrite struct {
} `yaml:"-"` } `yaml:"-"`
} }
// UserInteractiveAuthConfig , configuration for user interactive Flow API. Contains sets of auth flows, // UserInteractiveAuthConfig is a configuration for user interactive Flow API.
// possible ways in which a client can authenticate via UIAA and params returned to the client for the same. // It contains sets of auth flows, which represent the possible ways a client
// can authenticate via User Interactive Authentication as well as any
// parameters returned to the client during this process.
// http://matrix.org/docs/spec/HEAD/client_server/r0.3.0.html#user-interactive-authentication-api // http://matrix.org/docs/spec/HEAD/client_server/r0.3.0.html#user-interactive-authentication-api
type UserInteractiveAuthConfig struct { type UserInteractiveAuthConfig struct {
// Flows is a slice of flows, which represent one possible way that the client can authenticate a request. // Flows is a slice of flows, which represent one possible way that the client can authenticate a request.