-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into TSVB_migrate_split_filters_from_7_3
- Loading branch information
Showing
130 changed files
with
2,038 additions
and
826 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
.../development/core/public/kibana-plugin-public.httpservicebase.anonymouspaths.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) > [anonymousPaths](./kibana-plugin-public.httpservicebase.anonymouspaths.md) | ||
|
||
## HttpServiceBase.anonymousPaths property | ||
|
||
APIs for denoting certain paths for not requiring authentication | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
anonymousPaths: IAnonymousPaths; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
docs/development/core/public/kibana-plugin-public.ianonymouspaths.isanonymous.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [IAnonymousPaths](./kibana-plugin-public.ianonymouspaths.md) > [isAnonymous](./kibana-plugin-public.ianonymouspaths.isanonymous.md) | ||
|
||
## IAnonymousPaths.isAnonymous() method | ||
|
||
Determines whether the provided path doesn't require authentication | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isAnonymous(path: string): boolean; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| path | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`boolean` | ||
|
21 changes: 21 additions & 0 deletions
21
docs/development/core/public/kibana-plugin-public.ianonymouspaths.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [IAnonymousPaths](./kibana-plugin-public.ianonymouspaths.md) | ||
|
||
## IAnonymousPaths interface | ||
|
||
APIs for denoting paths as not requiring authentication | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IAnonymousPaths | ||
``` | ||
|
||
## Methods | ||
|
||
| Method | Description | | ||
| --- | --- | | ||
| [isAnonymous(path)](./kibana-plugin-public.ianonymouspaths.isanonymous.md) | Determines whether the provided path doesn't require authentication | | ||
| [register(path)](./kibana-plugin-public.ianonymouspaths.register.md) | Register <code>path</code> as not requiring authentication | | ||
|
24 changes: 24 additions & 0 deletions
24
docs/development/core/public/kibana-plugin-public.ianonymouspaths.register.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [IAnonymousPaths](./kibana-plugin-public.ianonymouspaths.md) > [register](./kibana-plugin-public.ianonymouspaths.register.md) | ||
|
||
## IAnonymousPaths.register() method | ||
|
||
Register `path` as not requiring authentication | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
register(path: string): void; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| path | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`void` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
import { AnonymousPaths } from './anonymous_paths'; | ||
import { BasePath } from './base_path_service'; | ||
|
||
describe('#register', () => { | ||
it(`allows paths that don't start with /`, () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('bar'); | ||
}); | ||
|
||
it(`allows paths that end with '/'`, () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar/'); | ||
}); | ||
}); | ||
|
||
describe('#isAnonymous', () => { | ||
it('returns true for registered paths', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar'); | ||
expect(anonymousPaths.isAnonymous('/foo/bar')).toBe(true); | ||
}); | ||
|
||
it('returns true for paths registered with a trailing slash, but call "isAnonymous" with no trailing slash', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar/'); | ||
expect(anonymousPaths.isAnonymous('/foo/bar')).toBe(true); | ||
}); | ||
|
||
it('returns true for paths registered without a trailing slash, but call "isAnonymous" with a trailing slash', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar'); | ||
expect(anonymousPaths.isAnonymous('/foo/bar/')).toBe(true); | ||
}); | ||
|
||
it('returns true for paths registered without a starting slash', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('bar'); | ||
expect(anonymousPaths.isAnonymous('/foo/bar')).toBe(true); | ||
}); | ||
|
||
it('returns true for paths registered with a starting slash', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar'); | ||
expect(anonymousPaths.isAnonymous('/foo/bar')).toBe(true); | ||
}); | ||
|
||
it('when there is no basePath and calling "isAnonymous" without a starting slash, returns true for paths registered with a starting slash', () => { | ||
const basePath = new BasePath('/'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar'); | ||
expect(anonymousPaths.isAnonymous('bar')).toBe(true); | ||
}); | ||
|
||
it('when there is no basePath and calling "isAnonymous" with a starting slash, returns true for paths registered with a starting slash', () => { | ||
const basePath = new BasePath('/'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar'); | ||
expect(anonymousPaths.isAnonymous('/bar')).toBe(true); | ||
}); | ||
|
||
it('returns true for paths whose capitalization is different', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/BAR'); | ||
expect(anonymousPaths.isAnonymous('/foo/bar')).toBe(true); | ||
}); | ||
|
||
it('returns false for other paths', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar'); | ||
expect(anonymousPaths.isAnonymous('/foo/foo')).toBe(false); | ||
}); | ||
|
||
it('returns false for sub-paths of registered paths', () => { | ||
const basePath = new BasePath('/foo'); | ||
const anonymousPaths = new AnonymousPaths(basePath); | ||
anonymousPaths.register('/bar'); | ||
expect(anonymousPaths.isAnonymous('/foo/bar/baz')).toBe(false); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
import { IAnonymousPaths, IBasePath } from 'src/core/public'; | ||
|
||
export class AnonymousPaths implements IAnonymousPaths { | ||
private readonly paths = new Set<string>(); | ||
|
||
constructor(private basePath: IBasePath) {} | ||
|
||
public isAnonymous(path: string): boolean { | ||
const pathWithoutBasePath = this.basePath.remove(path); | ||
return this.paths.has(this.normalizePath(pathWithoutBasePath)); | ||
} | ||
|
||
public register(path: string) { | ||
this.paths.add(this.normalizePath(path)); | ||
} | ||
|
||
private normalizePath(path: string) { | ||
// always lower-case it | ||
let normalized = path.toLowerCase(); | ||
|
||
// remove the slash from the end | ||
if (normalized.endsWith('/')) { | ||
normalized = normalized.slice(0, normalized.length - 1); | ||
} | ||
|
||
// put a slash at the start | ||
if (!normalized.startsWith('/')) { | ||
normalized = `/${normalized}`; | ||
} | ||
|
||
// it's normalized!!! | ||
return normalized; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.