Added access control public header file. #1300
Merged
Conversation
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
ethouris
added
Priority: High
Type: Enhancement
ethouris
commented
May 22, 2020
33 tasks
Co-authored-by: Maxim Sharabayko <maxlovic@gmail.com>
docs/AccessControl.md
Outdated
Comment on lines
131
to
133
| Codes from this range can be only understood if both applications know the | ||
| code definitions of the other, and these should be used only after making | ||
| sure that both applications understood these codes. |
There was a problem hiding this comment.
Suggested change
| Codes from this range can be only understood if both applications know the | |
| code definitions of the other, and these should be used only after making | |
| sure that both applications understood these codes. | |
| Codes from this range can be only understood if each applications knows the | |
| code definitions of the other. These codes should be used only after making | |
| sure that both applications understood them. |
docs/AccessControl.md
Outdated
Comment on lines
135
to
136
| The intention for the predefined codes is to be consistent with the HTTP | ||
| standard codes, therefore there are following sub-ranges used: |
There was a problem hiding this comment.
Suggested change
| The intention for the predefined codes is to be consistent with the HTTP | |
| standard codes, therefore there are following sub-ranges used: | |
| The intention for the predefined codes is to be consistent with HTTP | |
| standard codes. Therefore the following sub-ranges are used: |
docs/AccessControl.md
Outdated
| * 400 - 599: Client and server errors in HTTP, adopted by SRT | ||
| * 600 - 999: unused in SRT | ||
|
|
||
| This code can be set by using the `srt_setrejectreason` function. |
There was a problem hiding this comment.
Suggested change
| This code can be set by using the `srt_setrejectreason` function. | |
| Such a code can be set by using the `srt_setrejectreason` function. |
docs/AccessControl.md
Outdated
Comment on lines
149
to
152
| This code should be set by the callback handler in the beginning in case | ||
| when the application needs to be informed that the callback handler | ||
| actually has interpreted the incoming connection, but it didn't set any | ||
| more appropriate code describing the situation. |
There was a problem hiding this comment.
Suggested change
| This code should be set by the callback handler in the beginning in case | |
| when the application needs to be informed that the callback handler | |
| actually has interpreted the incoming connection, but it didn't set any | |
| more appropriate code describing the situation. | |
| This code should be set by the callback handler in the beginning in case | |
| the application needs to be informed that the callback handler | |
| actually has interpreted the incoming connection, but hasn't set a | |
| more appropriate code describing the situation. |
docs/AccessControl.md
Outdated
| Authentication failed, which makes the client unauthorized to access the | ||
| resource. This error, however, confirms that the syntax is correct and | ||
| the resource has been properly identified. Note that this cannot be | ||
| reported in case when you use a simple user-password authentication |
There was a problem hiding this comment.
Suggested change
| reported in case when you use a simple user-password authentication | |
| reported when you use a simple user-password authentication |
docs/AccessControl.md
Outdated
Comment on lines
242
to
246
| The resource specified in the `r` key (with combination of `h` key) | ||
| is not found at this time. This error should be only reported if the | ||
| information about resource accessibility is allowed to be publicly | ||
| visible, otherwise the application might rather report authorization | ||
| errors. |
There was a problem hiding this comment.
Suggested change
| The resource specified in the `r` key (with combination of `h` key) | |
| is not found at this time. This error should be only reported if the | |
| information about resource accessibility is allowed to be publicly | |
| visible, otherwise the application might rather report authorization | |
| errors. | |
| The resource specified in the `r` key (in combination with the `h` key) | |
| is not found at this time. This error should be only reported if the | |
| information about resource accessibility is allowed to be publicly | |
| visible. Otherwise the application might report authorization | |
| errors. |
docs/AccessControl.md
Outdated
| ### SRT_REJX_CONFLICT | ||
|
|
||
| The resource being accessed is already locked for modification. This error | ||
| should only be reported for `m=publish` in case when the resource being |
There was a problem hiding this comment.
Suggested change
| should only be reported for `m=publish` in case when the resource being | |
| should only be reported for `m=publish` when the resource being |
docs/AccessControl.md
Outdated
|
|
||
| ### SRT_REJX_UNIMPLEMENTED | ||
|
|
||
| The request was correctly recognized, but the current version doesn't |
There was a problem hiding this comment.
"current version" of what? SRT? The application? Both? Later you refer to a "server version". How does this relate to SRT and/or the application?
There was a problem hiding this comment.
It's all about the server version. The rejection codes concern exclusively a situation when you have a service hanging as "SRT Listener" and a client tries to connect, with having a query specified in the StreamID field. Although yes, it should be clarified that it's about the version of the server application (can be both SRT or any other part of the service software).
docs/AccessControl.md
Outdated
Comment on lines
333
to
335
| The service is down for maintenance. This can only be reported in | ||
| case when the servis has been temporarily replaced by a stub that is only | ||
| reporting this error, while the real service is down for maintenance. |
There was a problem hiding this comment.
Suggested change
| The service is down for maintenance. This can only be reported in | |
| case when the servis has been temporarily replaced by a stub that is only | |
| reporting this error, while the real service is down for maintenance. | |
| The service is down for maintenance. This can only be reported | |
| when the service has been temporarily replaced by a stub that is only | |
| reporting this error, while the real service is down for maintenance. |
|
what api should we use to set these rejection reasons ? |
|
See |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This header file contains now only the predefined rejection codes.
It's also intended to be expanded in future to contain also function headers for utilities that allow to parse the StreamID according to the access control standard syntax.