diff --git a/src/github.com/matrix-org/dendrite/clientapi/routing/user_interactive_auth_flow.go b/src/github.com/matrix-org/dendrite/clientapi/routing/user_interactive_auth_flow.go index c3943459..a39f58ec 100644 --- a/src/github.com/matrix-org/dendrite/clientapi/routing/user_interactive_auth_flow.go +++ b/src/github.com/matrix-org/dendrite/clientapi/routing/user_interactive_auth_flow.go @@ -1,5 +1,4 @@ -// Copyright 2017 Vector Creations Ltd -// Copyright 2017 New Vector Ltd +// Copyright 2018 New Vector Ltd // // Licensed under the Apache License, Version 2.0 (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. -// 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 // and returns UserInteractiveResponse as specified in // 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( req *http.Request, r UserInteractiveFlowRequest, diff --git a/src/github.com/matrix-org/dendrite/common/config/config.go b/src/github.com/matrix-org/dendrite/common/config/config.go index b681bae8..ead3bbb9 100644 --- a/src/github.com/matrix-org/dendrite/common/config/config.go +++ b/src/github.com/matrix-org/dendrite/common/config/config.go @@ -241,8 +241,10 @@ type Dendrite struct { } `yaml:"-"` } -// UserInteractiveAuthConfig , configuration for user interactive Flow API. Contains sets of auth flows, -// possible ways in which a client can authenticate via UIAA and params returned to the client for the same. +// UserInteractiveAuthConfig is a configuration for user interactive Flow API. +// 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 type UserInteractiveAuthConfig struct { // Flows is a slice of flows, which represent one possible way that the client can authenticate a request.