Difference between revisions of "Security: Use Cases"

From BaseX Documentation
Jump to navigation Jump to search
m
Line 3: Line 3:
 
Annotation specification (first thoughts):
 
Annotation specification (first thoughts):
  
(: The basic security annotation enforcing a authorization on method invocation.:)
+
(: The basic security annotation enforcing a authorization on method invocation.:) <br />
(: The literal defines a principal which must be assigned to the current logged in user :)
+
(: The literal defines a principal which must be assigned to the current logged in user :) <br />
(: If the authorization was not successfull the default authorization fallback is called. @see %sec:authorization-fallback() :)
+
(: If the authorization was not successfull the default authorization fallback is called. @see %sec:authorization-fallback() :) <br />
%sec:requires-principal(string)
+
%sec:requires-principal(string) <br />
  
(: The basic security annotation enforcing a authorization on method invocation.:)
+
(: The basic security annotation enforcing a authorization on method invocation.:) <br />
(: The first literal defines a principal which must be assigned to the current logged in user :)
+
(: The first literal defines a principal which must be assigned to the current logged in user :) <br />
(: The second defines the fallback function which should be called if the authorization was not successful @see %sec:authorization-fallback(string) :)
+
(: The second defines the fallback function which should be called if the authorization was not successful @see %sec:authorization-fallback(string) :) <br />
%sec:requires-principal(string,string)
+
%sec:requires-principal(string,string) <br />
  
(: The default authorization fallback function. The function must not have any arguments :)
+
(: The default authorization fallback function. The function must not have any arguments :) <br />
(: relevant information like the current username might be available through additional xquery function in the security module :)
+
(: relevant information like the current username might be available through additional xquery function in the security module :) <br />
%sec:authorization-fallback()
+
%sec:authorization-fallback() <br />
  
(: An authorization fallback function addressable for %sec:requires-principal(string,string) by given id. The function must not have any arguments :)
+
(: An authorization fallback function addressable for %sec:requires-principal(string,string) by given id. The function must not have any arguments :) <br />
(: relevant information like the current username might be available through additional xquery function in the security module :)
+
(: relevant information like the current username might be available through additional xquery function in the security module :) <br />
%sec:authorization-fallback(string)
+
%sec:authorization-fallback(string) <br />
  
(: The default authentication fallback function. The function must not have any arguments :)
+
(: The default authentication fallback function. The function must not have any arguments :) <br />
(: relevant information like the current username might be available through additional xquery function in the security module :)
+
(: relevant information like the current username might be available through additional xquery function in the security module :) <br />
%sec:authentication-fallback()
+
%sec:authentication-fallback() <br />
  
(: Provides default credentials if the authentication was not successful :)
+
(: Provides default credentials if the authentication was not successful :) <br />
%sec:credentials()
+
%sec:credentials() <br />

Revision as of 11:21, 22 May 2013

This page will summarize first thoughts on annotation-based security/authentication support in BaseX.

Annotation specification (first thoughts):

(: The basic security annotation enforcing a authorization on method invocation.:)
(: The literal defines a principal which must be assigned to the current logged in user :)
(: If the authorization was not successfull the default authorization fallback is called. @see %sec:authorization-fallback() :)
%sec:requires-principal(string)

(: The basic security annotation enforcing a authorization on method invocation.:)
(: The first literal defines a principal which must be assigned to the current logged in user :)
(: The second defines the fallback function which should be called if the authorization was not successful @see %sec:authorization-fallback(string) :)
%sec:requires-principal(string,string)

(: The default authorization fallback function. The function must not have any arguments :)
(: relevant information like the current username might be available through additional xquery function in the security module :)
%sec:authorization-fallback()

(: An authorization fallback function addressable for %sec:requires-principal(string,string) by given id. The function must not have any arguments :)
(: relevant information like the current username might be available through additional xquery function in the security module :)
%sec:authorization-fallback(string)

(: The default authentication fallback function. The function must not have any arguments :)
(: relevant information like the current username might be available through additional xquery function in the security module :)
%sec:authentication-fallback()

(: Provides default credentials if the authentication was not successful :)
%sec:credentials()