matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-07 23:02:56 +03:00
Code Activity

Fix incorrect uses of IAuthData (#3322)

Browse Source 
`IAuthData` is the response, not the request
This commit is contained in:
Richard van der Hoff
2023-04-26 19:15:58 +01:00
committed by GitHub
parent 93e2135223
commit 4bdb9111dd
3 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/@types/uia.ts
View File

@@ -14,13 +14,13 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
import { IAuthData } from "../interactive-auth"; import { IAuthDict, IAuthData } from "../interactive-auth";
/** /**
* Helper type to represent HTTP request body for a UIA enabled endpoint * Helper type to represent HTTP request body for a UIA enabled endpoint
*/ */
export type UIARequest<T> = T & { export type UIARequest<T> = T & {
auth?: IAuthData; auth?: IAuthDict;
}; };
/** /**

6
src/client.ts
View File

@@ -715,7 +715,7 @@ interface IJoinedMembersResponse {
} }
export interface IRegisterRequestParams { export interface IRegisterRequestParams {
auth?: IAuthData; auth?: IAuthDict;
username?: string; username?: string;
password?: string; password?: string;
refresh_token?: boolean; refresh_token?: boolean;
@@ -7857,7 +7857,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
* @returns Promise which resolves: On success, the token response * @returns Promise which resolves: On success, the token response
* or UIA auth data. * or UIA auth data.
*/ */
public async requestLoginToken(auth?: IAuthData): Promise<UIAResponse<LoginTokenPostResponse>> { public async requestLoginToken(auth?: IAuthDict): Promise<UIAResponse<LoginTokenPostResponse>> {
// use capabilities to determine which revision of the MSC is being used // use capabilities to determine which revision of the MSC is being used
const capabilities = await this.getCapabilities(); const capabilities = await this.getCapabilities();
// use r1 endpoint if capability is exposed otherwise use old r0 endpoint // use r1 endpoint if capability is exposed otherwise use old r0 endpoint
@@ -8842,7 +8842,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
return this.http.authedRequest(Method.Get, "/keys/changes", qps); return this.http.authedRequest(Method.Get, "/keys/changes", qps);
} }
public uploadDeviceSigningKeys(auth?: IAuthData, keys?: CrossSigningKeys): Promise<{}> { public uploadDeviceSigningKeys(auth?: IAuthDict, keys?: CrossSigningKeys): Promise<{}> {
// API returns empty object // API returns empty object
const data = Object.assign({}, keys); const data = Object.assign({}, keys);
if (auth) Object.assign(data, { auth }); if (auth) Object.assign(data, { auth });

14
src/interactive-auth.ts
View File

@@ -44,7 +44,14 @@ export interface IStageStatus {
error?: string; error?: string;
} }
/**
* Data returned in the body of a 401 response from a UIA endpoint.
*
* @see https://spec.matrix.org/v1.6/client-server-api/#user-interactive-api-in-the-rest-api
*/
export interface IAuthData { export interface IAuthData {
// XXX: many of the fields here (`type`, `available_flows`, `required_stages`, etc) look like they
// shouldn't be here. They aren't in the spec and it's unclear what they are supposed to do. Be wary of using them.
session?: string; session?: string;
type?: string; type?: string;
completed?: string[]; completed?: string[];
@@ -77,6 +84,11 @@ export enum AuthType {
UnstableRegistrationToken = "org.matrix.msc3231.login.registration_token", UnstableRegistrationToken = "org.matrix.msc3231.login.registration_token",
} }
/**
* The parameters which are submitted as the `auth` dict in a UIA request
*
* @see https://spec.matrix.org/v1.6/client-server-api/#authentication-types
*/
export interface IAuthDict { export interface IAuthDict {
// [key: string]: any; // [key: string]: any;
type?: string; type?: string;
@@ -441,7 +453,7 @@ export class InteractiveAuth {
* This can be set to true for requests that just poll to see if auth has * This can be set to true for requests that just poll to see if auth has
* been completed elsewhere. * been completed elsewhere.
*/ */
private async doRequest(auth: IAuthData | null, background = false): Promise<void> { private async doRequest(auth: IAuthDict | null, background = false): Promise<void> {
try { try {
const result = await this.requestCallback(auth, background); const result = await this.requestCallback(auth, background);
this.attemptAuthDeferred!.resolve(result); this.attemptAuthDeferred!.resolve(result);