This is an automated email from the ASF dual-hosted git repository. djencks pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/felix-antora-site.git
commit 9913ed4a67c7051beb06093525dbf68f0c79a9e7 Author: David Jencks <[email protected]> AuthorDate: Sun Jul 11 15:53:47 2021 -0700 remove user admin doc (unmaintained) --- modules/ROOT/pages/documentation/subprojects.adoc | 2 +- .../subprojects/apache-felix-user-admin.adoc | 11 -------- .../apache-felix-user-admin-background.adoc | 25 ------------------ .../apache-felix-user-admin-file-store.adoc | 25 ------------------ .../apache-felix-user-admin-getting-started.adoc | 30 ---------------------- .../apache-felix-user-admin-introduction.adoc | 4 --- .../apache-felix-user-admin-mongodb-store.adoc | 25 ------------------ 7 files changed, 1 insertion(+), 121 deletions(-) diff --git a/modules/ROOT/pages/documentation/subprojects.adoc b/modules/ROOT/pages/documentation/subprojects.adoc index 2584fbe..1cb0389 100644 --- a/modules/ROOT/pages/documentation/subprojects.adoc +++ b/modules/ROOT/pages/documentation/subprojects.adoc @@ -129,4 +129,4 @@ The last documentation may be found in the https://github.com/apache/felix-site- * https://github.com/apache/felix-site-pub/blob/last-cms/documentation/subprojects/apache-felix-script-console-plugin.html[Script Console Plugin] * https://github.com/apache/felix-site-pub/blob/last-cms/documentation/subprojects/apache-felix-serialization-framework.html[Serialization Framework] * https://github.com/apache/felix-site-pub/blob/last-cms/documentation/subprojects/apache-felix-upnp.html[UPnP] -* xref:documentation/subprojects/apache-felix-user-admin.adoc[User Admin] +* https://github.com/apache/felix-site-pub/blob/last-cms/documentation/subprojects/apache-felix-user-admin.html[User Admin] diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin.adoc deleted file mode 100644 index 6671254..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= Apache Felix User Admin - -{include:Apache Felix User Admin - Introduction} - -== Table of contents - -* xref:documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-background.adoc[Background] explains the problem being solved and the main design goals; -* xref:documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-getting-started.adoc[Getting Started] helps you with the basic concepts by example; -* xref:documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-file-store.adoc[Using the file store] helps you with using the file-based repository store; -* xref:documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-mongodb-store.adoc[Using the MongoDB store] helps you with using the MongoDB-based repository store; -* xref:documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-custom-repository-store.adoc(broken link)Writing custom repository stores helps you in writing your own repository store. diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-background.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-background.adoc deleted file mode 100644 index 3492258..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-background.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Apache Felix User Admin - Background - -For a detailed overview on the UserAdmin service, see the OSGi compendium specification version 4.0 or later. - -== Roles - -The UserAdmin service defines two types of roles: _users_ and _groups_. -Other types of roles are not and cannot be defined. - -=== Users - -According to the UserAdmin specification, a `User` role refers to "??any entity that may have any number of credentials associated with it that it may use to authenticate itself??." Normally, `User` roles are used to authenticate an initiator of a certain action. -Although the name suggests otherwise, a `User` role can also denote anything other than a human being. -Examples of valid `User` roles are: - -* A human being with a username and password; -* A machine with a hostname and SSL-certificate. - -=== Groups - -A group is an aggregation of other users and groups, allowing you to create authorization schemes. -Roles are either _required_ or _basic_ members of a group. -The basic members of a group define the set of members that can be authorized. -This set is further reduced by requiring an initiator of an action to imply all required member of a group. -A group can be implied only if it has at least one basic member and at least one required member. diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-file-store.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-file-store.adoc deleted file mode 100644 index b1c97b3..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-file-store.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Apache Felix User Admin - File Store - -The Apache Felix User Admin file store provides a file-based store for use with the Felix UserAdmin service. -It uses a binary file-format to persist the role information. -This file will always be written in the data area of the bundle and be called "[.code]``ua_repo.dat``". - -The file-based store service this bundle provides can be configured at runtime by using the service PID "[.code]``org.apache.felix.useradmin.filestore``". -The configuration options recognized by this service are: - -* "[.code]``background.write.disabled``"; -by default, all changes made to the UserAdmin repository are flushed to disk. -By setting this value to "[.code]``true``", this no longer will happen for each change, but only when the file-store service is stopped. -This value is optional and defaults to "[.code]``false``"; -* "[.code]``background.write.delay.value``"; -denotes the period after which the changes should be persisted to disk. -If other changes to the repository occur during this period, the period will start over. -This value is optional and defaults to "[.code]``500``"; -* "[.code]``background.write.delay.timeunit``"; -denotes the time unit for "background.write.delay.value". -This value is optional and defaults to "[.code]``milliseconds``". -Possible values are: "[.code]``days``", "[.code]``hours``", "[.code]``minutes``", "[.code]``seconds``", "[.code]``milliseconds``", "[.code]``microseconds``" and "[.code]``nanoseconds``". - -Alternatively, one can also supply the above mentioned configuration keys prefixed with "[.code]``org.apache.felix.useradmin.filestore.``" as system properties. -For example by adding `-Dorg.apache.felix.useradmin.filestore.background.write.disabled=true` to your JVM arguments will disable persisting the changes upon each change. -However, using system properties will imply that only a single store can be configured on a system (which could be a sensible default for some situations)! diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-getting-started.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-getting-started.adoc deleted file mode 100644 index c710512..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-getting-started.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= Apache Felix User Admin - Getting Started - -== Authentication - -To test whether an initiator of an action is known to the UserAdmin service, it should be authenticated. -To authenticate a user, you typically do something like: - -{code:java} private UserAdmin m_userAdmin; -// ... -User user = m_userAdmin.getUser("username", getUserName()); -if (user == null || !user.hasCredential("password", getPassword())) { throw new InvalidUsernameOrPasswordException(); -} - ----- -h2. Authorization - -Only authorized users should be able to initiate privileged actions. Whether a user is authorized to do so depends on its membership in groups. The UserAdmin service aids in this by providing an {{Authorization}} facade that helps you to determine whether or not users are authorized to initiate certain actions. - -Note that the UserAdmin only provides answer to the question whether a user is allowed to initiate a certain action, it does not actually shield it from doing this, like, for example, the SecurityManager in Java. This means that the common pattern used to authorize users with UserAdmin looks something like: - -{code:java} -private UserAdmin m_userAdmin; -// ... -User user = m_userAdmin.getUser("username", getUserName()); -// assume user is already authenticated... -Authorization auth = m_userAdmin.getAuthorization(user); -if (!auth.hasRole("admin")) { - throw new InsufficientRightsException(); -} ----- diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-introduction.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-introduction.adoc deleted file mode 100644 index 4518493..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-introduction.adoc +++ /dev/null @@ -1,4 +0,0 @@ -= Apache Felix User Admin - Introduction - -The Apache Felix User Admin provides an implementation of the OSGi UserAdmin compendium service. -It allows you to manage roles (users and groups), define RBAC-like authorization schemes and test whether certain roles are authorized to initiate certain actions. diff --git a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-mongodb-store.adoc b/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-mongodb-store.adoc deleted file mode 100644 index 52b5de7..0000000 --- a/modules/ROOT/pages/documentation/subprojects/apache-felix-user-admin/apache-felix-user-admin-mongodb-store.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Apache Felix User Admin - MongoDB Store - -The Apache Felix User Admin MongoDB store provides a MongoDB-based store for use with the Felix UserAdmin service. -It uses MongoDB to persist the role information. - -Note that this driver additionally needs the http://www.mongodb.org/display/DOCS/Java+Language+Center[MongoDB java driver] in order to operate! - -The MongoDB-based store service this bundle provides can be configured at runtime by using the service PID "[.code]``org.apache.felix.useradmin.mongodb``". -The configuration options recognized by this service are: - -* "[.code]``server``": a space separated string containing the MongoDB servers. -The format for this string is: "[.code]``<host1:port1> <host2:port2>``". -This value is optional and defaults to "[.code]``localhost:27017``"; -* "[.code]``dbname``": a string value containing the name of the database to use for this store. -This value is optional and defaults to "[.code]``ua_repo``"; -* "[.code]``collection``": the name of the database collection to use for this store. -This value is optional and defaults to "[.code]``useradmin``"; -* "[.code]``username``": a string value representing the name of the user to authenticate against MongoDB. -This value is optional and defaults to "" (empty string); -* "[.code]``password``": a string value representing the password to authenticate against MongoDB. -This value is optional and defaults to "" (empty string). - -Alternatively, one can also supply the above mentioned configuration keys prefixed with "[.code]``org.apache.felix.useradmin.mongodb.``" as system properties. -For example by adding `-Dorg.apache.felix.useradmin.mongodb.server=my.mongo.server:29000` to your JVM arguments will let this service use the MongoDB server at "[.code]``my.mongo.server``" on port 29000. -However, using system properties will imply that only a single store can be configured on a system (which could be a sensible default for some situations)!
