Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User roles proposal #454

Open
wants to merge 19 commits into
base: development
Choose a base branch
from
Open

Conversation

ocampana-videotec
Copy link
Contributor

Initial proposal for implementing editable user levels. They are necessary for SOAP over SCTP in WebRTC sessions.

<xs:sequence>
<xs:element name="Name" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the editable user level.</xs:documentation>
Copy link
Contributor

@venki5685 venki5685 Aug 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently ONVIF have Administrator, Operator, User, Anonymous, Extended User levels defined and the access permissions for these user levels also pre-defined. So Name parameter in EditableUserLevel should not conflict with any of the existing ONVIF Pre-Defined user levels so that the behavior of the ONVIf pre-defined user levels should not be changed. I also do not know the current usage of Extended User level pre-defined.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my vision, they do not conflic, because to use the EditableUserLevels the Userlevel must always be set to extended. But I understand that this may lead to tricky names. So, let's gather the opinion of other members.

@jflevesque-genetec
Copy link
Contributor

Is it possible not to include whitespace changes or similar changes in the PR? It makes it terribly difficult to find the actual changes in the documents. If its a clean up we want, we should do that change in a separate PR so it can be accepted quickly so future changes include them by default.

doc/Core.xml Outdated
<para>A device that signals support for the Default Access Policy via the respective capability shall support at least one user of each user level Administrator, Operator and User.</para>
</section>
<section>
<title>Editable user levels</title>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this section define the expected behavior if a device receives a function it does not know (ex. new API call added, but device running older firmware)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you do not mind, I'd prefer to add a dedicated error in §8.4.10.2 (i.e. Set editable user level)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

During the San Diego F2F meeting, we agreed that we are going to ignore the unknown function

<xs:documentation>Name of the editable user level.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Functions" type="tt:StringList">
Copy link
Contributor

@tomasz-zajac tomasz-zajac Aug 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we consider more compact data representation? For example grouping methods by namespace:

  • namespace 1
    • function 1
    • function 2
    • function 3
  • namespace 2
    • function 1
    • function 2

@ocampana-videotec ocampana-videotec added enhancement New feature or request 25.06 labels Sep 11, 2024
@ocampana-videotec ocampana-videotec changed the title Video/editableuserlevels User roles proposal Sep 11, 2024
Copy link
Contributor

@kieran242 kieran242 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I performed a full review

@@ -65,6 +65,14 @@
</author>
<revremark>Add support for WebSocket protocol and token authorization.</revremark>
</revision>
<revision>
<revnumber>25.06</revnumber>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this not change Version and Date? or are we waiting until the changes are merged?

doc/Uplink.xml Outdated Show resolved Hide resolved
doc/Security.xml Outdated Show resolved Hide resolved
@@ -10,7 +10,7 @@ IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FO
-->
<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tds="http://www.onvif.org/ver10/device/wsdl" targetNamespace="http://www.onvif.org/ver10/device/wsdl">
<wsdl:types>
<xs:schema targetNamespace="http://www.onvif.org/ver10/device/wsdl" xmlns:tt="http://www.onvif.org/ver10/schema" xmlns:tds="http://www.onvif.org/ver10/device/wsdl" elementFormDefault="qualified" version="23.12">
<xs:schema targetNamespace="http://www.onvif.org/ver10/device/wsdl" xmlns:tt="http://www.onvif.org/ver10/schema" xmlns:tds="http://www.onvif.org/ver10/device/wsdl" elementFormDefault="qualified" version="25.06">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my earlier comment.

wsdl/ver10/device/wsdl/devicemgmt.wsdl Outdated Show resolved Hide resolved
<listitem>
<para><emphasis>onvif:User</emphasis> : the predefined role corresponding to the User
user level. Users with User user level and extended users with onvif:User role shall
be idempotent.</para>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
be idempotent.</para>
be unchanged.</para>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I am trying to state is that they should have the same access. Maybe idempotent is too mathematical, but I do not think that unchanged is the right word to express the concept.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

During the San Diego F2F meeting, we agreed to use identical

doc/Core.xml Show resolved Hide resolved
doc/Core.xml Outdated Show resolved Hide resolved
doc/Core.xml Outdated Show resolved Hide resolved
doc/Core.xml Outdated Show resolved Hide resolved
@kieran242
Copy link
Contributor

Is it possible not to include white-space changes or similar changes in the PR? It makes it terribly difficult to find the actual changes in the documents. If its a clean up we want, we should do that change in a separate PR so it can be accepted quickly so future changes include them by default.

I do agree with this comment there was a lot in this PR not related to the topic that was highlighted as changed. I do not believe ether that it was deliberate.

I choose in this instance to identify grammar or spelling mistakes that the opportunity presented for correction and highlight them as suggestions for update and fix that should improve the quality of the final specifications.

ocampana-videotec and others added 6 commits November 10, 2024 20:19
Co-authored-by: Kieran McCartan <[email protected]>
Co-authored-by: Kieran McCartan <[email protected]>
Co-authored-by: Kieran McCartan <[email protected]>
Co-authored-by: Kieran McCartan <[email protected]>
Co-authored-by: Kieran McCartan <[email protected]>
@ocampana-videotec ocampana-videotec marked this pull request as ready for review November 12, 2024 18:35
wsdl/ver10/device/wsdl/devicemgmt.wsdl Outdated Show resolved Hide resolved
wsdl/ver10/device/wsdl/devicemgmt.wsdl Outdated Show resolved Hide resolved
</xs:annotation>
</xs:element>
<xs:element name="Functions" type="tt:StringList">
<xs:annotation>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the predefined userroles like onvif:Administrator etc., the functions parameter can be empty ? or do we have fill this for pre-defined userroles also ? can we clarify this somewhere.

@sujithhanwha sujithhanwha added 25.12 and removed 25.06 labels Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
25.12 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants