Package com.illumon.iris.db.v2.permissions

Class EtcdDbAclProvider

java.lang.Object
com.illumon.iris.db.v2.permissions.EtcdDbAclProvider
All Implemented Interfaces:
com.fishlib.auth.AuthModule, DbAclProvider, DbAclWriter, AutoCloseable
Direct Known Subclasses:
EtcdDbAclGuiHelper, UnauthenticatedPermissionFilterProviderEtcdImpl
public class EtcdDbAclProvider
extends Object
implements DbAclProvider, com.fishlib.auth.AuthModule, AutoCloseable
Access to the Etcd ACL database.

This class implements DbAclProvider, AuthModule, and DbAclWriter and serves as the basis for the Etcd permission filter provider, as well as the GUI helper. Anything that talks to the Etcd ACL database should use or extend it. All things that had embedded SQL in the MysqlDbAclGuiHelper have had the SQL-replacement aspects moved into this class, so that direct interaction with kv-acl objects is entirely in this class, and, from here, through the kv-acl AclJetcdProvider.

  • Constructor Details

  • Method Details

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface DbAclProvider

    • getFilterDetailsForUser

      @NotNull public List<PermissionFilterProvider.FilterDetails> getFilterDetailsForUser​(com.fishlib.auth.UserContext userContext)
      Description copied from interface: DbAclProvider
      Gets the tableacls permissions filters for an effective user
      Specified by:
      getFilterDetailsForUser in interface DbAclProvider
      Parameters:
      userContext - The UserContext from which the effective user name to filter will be obtained
      Returns:
      A List of PermissionFilterProvider.FilterDetails for the effective user

    • retrieveRowAcls

      @NotNull public Collection<String> retrieveRowAcls​(String effectiveUser, String namespace, String tableName)
      Description copied from interface: DbAclProvider
      Returns the most specific tableacl per group for a specific user, namespace, and table.
      Specified by:
      retrieveRowAcls in interface DbAclProvider
      Parameters:
      effectiveUser - the user for which acls should be retrieved
      namespace - the namespace specifically for which acls should be retrieved - will also match * in tableacls
      tableName - the table name specifically for which acls should be retrieved - will also match * in tableacls
      Returns:
      A Collection of tableacls filters.

    • retrieveColumnAcls

      @NotNull public Map<String,​List<com.fishlib.base.Pair<String,​String>>> retrieveColumnAcls​(String effectiveUser, String namespace, String tableName)
      Description copied from interface: DbAclProvider
      Returns the most specific columnacl per group for a specific user, namespace, and table.
      Specified by:
      retrieveColumnAcls in interface DbAclProvider
      Parameters:
      effectiveUser - the user for which acls should be retrieved
      namespace - the namespace specifically for which acls should be retrieved - will also match * in columnacls
      tableName - the table name specifically for which acls should be retrieved - will also match * in columnacls
      Returns:
      A Map of group names to Lists of columns and filter pairs.

    • retrieveSystemAcls

      @NotNull public Collection<String> retrieveSystemAcls​(String effectiveUser, String key)
      Retrieve the set of system ACLs that modify system behavior rather than table access.
      Specified by:
      retrieveSystemAcls in interface DbAclProvider
      Parameters:
      effectiveUser - The user to get ACLs for
      key - The lookup value that applies
      Returns:
      A collection of strings representing the applicable state.getAcls().

    • canEditInputTable

      public boolean canEditInputTable​(String effectiveUser, String namespace, String tableName)
      Description copied from interface: DbAclProvider
      Checks whether a user has rights to edit an input table
      Specified by:
      canEditInputTable in interface DbAclProvider
      Parameters:
      effectiveUser - The user for whom permissions should be checked
      namespace - the namespace specifically for which acls should be retrieved - will also match * in inputtableeditors
      tableName - the table name specifically for which acls should be retrieved - will also match * in inputtableeditors
      Returns:
      True if the user has an effective canedit grant, otherwise false

    • canAnyoneEditInputTable

      public boolean canAnyoneEditInputTable​(String namespace, String tableName)
      Description copied from interface: DbAclProvider
      Checks whether an input table can be edited by all users
      Specified by:
      canAnyoneEditInputTable in interface DbAclProvider
      Parameters:
      namespace - the namespace specifically for which acls should be retrieved - will also match * in inputtableeditors
      tableName - the table name specifically for which acls should be retrieved - will also match * in inputtableeditors
      Returns:
      True if the input table can be edited by all users, otherwise false

    • getAccountsForUser

      @NotNull public String[] getAccountsForUser​(String effectiveUser)
      Description copied from interface: DbAclProvider
      Retrieves all strategy accounts associated with a user, directly or through group membership
      Specified by:
      getAccountsForUser in interface DbAclProvider
      Parameters:
      effectiveUser - The user for whom strategy account access should be checked
      Returns:
      An array of String of associated strategy accounts

    • getAllUsers

      @NotNull public String[] getAllUsers()
      Description copied from interface: DbAclProvider
      Retrieves all user accounts in the system
      Specified by:
      getAllUsers in interface DbAclProvider
      Returns:
      An array of String of user names

    • getAllGroups

      @NotNull public String[] getAllGroups()
      Description copied from interface: DbAclProvider
      Retrieves all groups accounts in the system
      Specified by:
      getAllGroups in interface DbAclProvider
      Returns:
      An array of String of groups names

    • getAllStrategies

      @NotNull public String[] getAllStrategies()
      Description copied from interface: DbAclProvider
      Retrieves all strategy names by unioning strategies in strategyaccount with those in groupstrategy
      Specified by:
      getAllStrategies in interface DbAclProvider
      Returns:
      An array of String of strategy names

    • getAllAccounts

      @NotNull public String[] getAllAccounts()
      Description copied from interface: DbAclProvider
      Retrieves all strategy accounts in the system
      Specified by:
      getAllAccounts in interface DbAclProvider
      Returns:
      An array of String of strategy account names

    • getAccountsForStrategy

      @NotNull public String[] getAccountsForStrategy​(String strategy)
      Description copied from interface: DbAclProvider
      Retrieves all strategy accounts associated with a particular strategy
      Specified by:
      getAccountsForStrategy in interface DbAclProvider
      Parameters:
      strategy - The strategy name for which to filter accounts
      Returns:
      An array of String of strategy account names

    • getStrategyForAccount

      @NotNull public String[] getStrategyForAccount​(String account)
      Description copied from interface: DbAclProvider
      Retrieves all strategies associated with a particular strategy account
      Specified by:
      getStrategyForAccount in interface DbAclProvider
      Parameters:
      account - The strategy account name for which to filter strategies
      Returns:
      An array of String of strategy account names

    • getAccountsForGroup

      @NotNull public String[] getAccountsForGroup​(String group)
      Description copied from interface: DbAclProvider
      Retrieves all strategy accounts associated with a particular group
      Specified by:
      getAccountsForGroup in interface DbAclProvider
      Parameters:
      group - The group name for which to filter accounts
      Returns:
      An array of String of strategy account names

    • getStrategiesForGroup

      @NotNull public String[] getStrategiesForGroup​(String group)
      Description copied from interface: DbAclProvider
      Retrieves all strategies associated with a particular group
      Specified by:
      getStrategiesForGroup in interface DbAclProvider
      Parameters:
      group - The group name for which to filter strategies
      Returns:
      An array of String of strategy names

    • getSystemUsers

      @NotNull public String[] getSystemUsers()
      Description copied from interface: DbAclProvider
      Returns an array of systemusers.
      Specified by:
      getSystemUsers in interface DbAclProvider
      Returns:
      A String array of distinct systemuser names, sorted.

    • getRunAsUserMap

      @NotNull public Map<String,​String> getRunAsUserMap()
      Description copied from interface: DbAclProvider
      Returns a map of user names to systemuser names
      Specified by:
      getRunAsUserMap in interface DbAclProvider
      Returns:
      a map of user names to systemuser names

    • getRunAsUser

      public String getRunAsUser​(String effectiveUser)
      Description copied from interface: DbAclProvider
      Returns the systemuser to which the effectiveUser is mapped, or null if no mapping exists.
      Specified by:
      getRunAsUser in interface DbAclProvider
      Parameters:
      effectiveUser - The user for which a mapped systemuser name should be retrieved.
      Returns:
      the String systemuser to which the effectiveUser is mapped, or null if no mapping exists.

    • groupStrategyExists

      public boolean groupStrategyExists​(String groupName, String strategy)
      Description copied from interface: DbAclProvider
      Checks whether a particular association of a group and a strategy exists
      Specified by:
      groupStrategyExists in interface DbAclProvider
      Parameters:
      groupName - The group name to check
      strategy - The strategy name to check
      Returns:
      True if the mapping exists, false if it does not

    • userExists

      public boolean userExists​(String username)
      Checks whether the user exists from the perspective of the Auth module, not necessarily in the ACL store.
      Specified by:
      userExists in interface com.fishlib.auth.AuthModule
      Parameters:
      username - The String user name to check.

    • isUserPassValid

      public boolean isUserPassValid​(String username, String password)
      Specified by:
      isUserPassValid in interface com.fishlib.auth.AuthModule

    • getPasswdsForMigration

      @NotNull public List<com.fishlib.base.Pair<String,​String>> getPasswdsForMigration()
      Returns user and password entries from the passwd table. Intended for use during ACL exports and/or data migration between MySQL and Etcd ACL stores.
      Specified by:
      getPasswdsForMigration in interface DbAclProvider
      Returns:
      A List of Pair&lt;String,String&gt; objects which contain a user and password entry.

    • getGroupsForUser

      @NotNull public String[] getGroupsForUser​(String effectiveUser)
      Description copied from interface: DbAclProvider
      Get the groups to which a user is mapped
      Specified by:
      getGroupsForUser in interface DbAclProvider
      Parameters:
      effectiveUser - The String name of the user to find groups for
      Returns:
      A String array of groups mapped to this user

    • getStrategiesForUser

      @NotNull public String[] getStrategiesForUser​(String effectiveUser)
      Description copied from interface: DbAclProvider
      Retrieves all strategies associated with a particular user, either directly or through group membership
      Specified by:
      getStrategiesForUser in interface DbAclProvider
      Parameters:
      effectiveUser - The user for whom strategy access should be checked
      Returns:
      An array of String of strategy names

    • getUsersForGroup

      @NotNull public String[] getUsersForGroup​(String group)
      Description copied from interface: DbAclProvider
      Get the users that are members of a group
      Specified by:
      getUsersForGroup in interface DbAclProvider
      Parameters:
      group - The String name of the group to find users for
      Returns:
      A String array of users with membership in this group

    • getAllUsersAndGroups

      public Table getAllUsersAndGroups()
      Returns a table of User and Groupname
      Returns:
      A Table of users and their group memberships

    • getAllGroupsAndStrategies

      public Table getAllGroupsAndStrategies()
      Returns a table of Groupname and Strategy
      Returns:
      A Table of groups and their corresponding strategies

    • getAllStrategiesAndAccounts

      public Table getAllStrategiesAndAccounts()
      Returns a table of Strategy and Account
      Returns:
      A Table of strategies and their corresponding accounts

    • getAllTableAcls

      public Table getAllTableAcls()
      Returns a table of Strategy and Account
      Returns:
      A Table of strategies and their corresponding accounts

    • getAllColumnAcls

      public Table getAllColumnAcls()
      Returns a table of Strategy and Account
      Returns:
      A Table of strategies and their corresponding accounts

    • getAllSystemAcls

      public Table getAllSystemAcls()
      Returns a table of all system ACLs
      Returns:
      A Table of system ACL groups, keys, and filters

    • getAllInputTableEditors

      public Table getAllInputTableEditors()
      Returns a table of all input table editor permissions
      Returns:
      A Table of input table editor groups, namespaces, table names, and permissions

    • getExternalAuthOnlyUsers

      public Table getExternalAuthOnlyUsers​(@NotNull List<String> invalidHashes)
      Returns a table with one column listing users whose passwords indicate external authentication.
      Parameters:
      invalidHashes - A List of password hashes that are valid only for external authentication.
      Returns:
      A Table of users

    • getAllUsersAndSystemUsers

      public Table getAllUsersAndSystemUsers()
      Returns a table of all Users and matching SystemUsers
      Returns:
      A Table of all users and systemuser mappings where they exist

    • getAllUsersAndSystemUsers

      public Table getAllUsersAndSystemUsers​(String groupName)
      Returns a table of all Users and matching SystemUsers
      Returns:
      A Table of all users and systemuser mappings where they exist

    • addMembership

      public void addMembership​(String user, List<String> groups)
      Description copied from interface: DbAclWriter
      Adds a user to a list of groups If the user could not be added to all of the groups, a RuntimeException is thrown.
      Specified by:
      addMembership in interface DbAclWriter
      Parameters:
      user - the user to add to the groups
      groups - a list of groups to add the user to

    • addUser

      public void addUser​(String user, String passwordHash)
      Description copied from interface: DbAclWriter
      Adds a user to the Iris system.
      Specified by:
      addUser in interface DbAclWriter
      Parameters:
      user - the user to add.
      passwordHash - the APR1 hash of the user's password. Ignored if the system is not configured to manage user authentication.

    • changePassword

      public void changePassword​(String user, String passwordHash)
      Description copied from interface: DbAclProvider
      Changes the password of a user entry in passwd
      Specified by:
      changePassword in interface DbAclProvider
      Specified by:
      changePassword in interface DbAclWriter
      Parameters:
      user - The user for which the password should be updated
      passwordHash - The new password value to store

    • removeMembership

      public void removeMembership​(String user, List<String> groups)
      Description copied from interface: DbAclWriter
      Removes a user from a list of groups. It is possible that the user may be removed from some groups and not others. If the user could not be removed from all of the specified groups (e.g., because they are not a member of those groups), a runtime exception is thrown.
      Specified by:
      removeMembership in interface DbAclWriter
      Parameters:
      user - the user to remove from groups
      groups - a list of groups to remove the user from

    • deleteAllAclData

      public void deleteAllAclData() throws SQLException
      Deletes all data in the ACL store. Use judiciously.
      Specified by:
      deleteAllAclData in interface DbAclWriter
      Throws:
      SQLException

    • deleteGroup

      public void deleteGroup​(String group)
      Description copied from interface: DbAclWriter
      Deletes a group. The group is removed from all user to group mappings, all group to strategy mappings. All table ACLs and input table editors that reference the group are deleted.
      Specified by:
      deleteGroup in interface DbAclWriter
      Parameters:
      group - the group to delete.

    • deleteUser

      public void deleteUser​(String user)
      Description copied from interface: DbAclWriter
      The user is deleted. Deletes the user's group, followed by deleting any other user to group associations for the user. If managed authentication is enabled, also deletes the user's password.
      Specified by:
      deleteUser in interface DbAclWriter
      Parameters:
      user - the user to delete

    • addGroupStrategy

      public void addGroupStrategy​(String group, String strategy)
      Description copied from interface: DbAclWriter
      For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will add a group to the intermediate "strategy".
      Specified by:
      addGroupStrategy in interface DbAclWriter
      Parameters:
      group - the group to map to a strategy
      strategy - the strategy that the group is added to

    • deleteGroupStrategy

      public void deleteGroupStrategy​(String group, String strategy)
      Description copied from interface: DbAclWriter
      For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will remove a group from the intermediate "strategy".
      Specified by:
      deleteGroupStrategy in interface DbAclWriter
      Parameters:
      group - the group to remove a mapping to a strategy
      strategy - the strategy that the group is removed from

    • addStrategyAccount

      public void addStrategyAccount​(String strategy, String account)
      Description copied from interface: DbAclWriter
      For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will add an account to the intermediate "strategy".
      Specified by:
      addStrategyAccount in interface DbAclWriter
      Parameters:
      strategy - the strategy that the account is added to
      account - the account to add to a strategy

    • deleteStrategyAccount

      public void deleteStrategyAccount​(String strategy, String account)
      Description copied from interface: DbAclWriter
      For AccountFilterGenerator() there are two levels of mappings. Group to strategy and strategy to account. This will remove an account from the intermediate "strategy".
      Specified by:
      deleteStrategyAccount in interface DbAclWriter
      Parameters:
      strategy - the strategy that the account is added to
      account - the account to add to a strategy

    • addAcl

      public int addAcl​(String group, String ns, String table, String acl)
      Description copied from interface: DbAclWriter
      Adds an ACL entry. No ACL entry may currently exist for the group and table in question.
      Specified by:
      addAcl in interface DbAclWriter
      Parameters:
      group - the group to add the entry for
      ns - the namespace to add the entry for ("*" for all namespaces)
      table - the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")
      acl - the ACL to add, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29
      Returns:
      the number of rows within the ACL database that were modified.

    • updateAcl

      public int updateAcl​(String group, String ns, String table, String acl)
      Description copied from interface: DbAclWriter
      Changes an already existent ACL entry. An ACL entry must currently exist for the group and table in question.
      Specified by:
      updateAcl in interface DbAclWriter
      Parameters:
      group - the group to update the entry for
      ns - the namespace to update the entry for ("*" for all namespaces)
      table - the namespace to update the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")
      acl - the new ACL, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29
      Returns:
      the number of rows within the ACL database that were modified.

    • deleteAcls

      public void deleteAcls​(String group, String ns, String table)
      Description copied from interface: DbAclWriter
      Deletes an ACL entry for a group and table.
      Specified by:
      deleteAcls in interface DbAclWriter
      Parameters:
      group - the group to remove the entry for
      ns - the namespace to remove the entry for ("*" for all namespaces)
      table - the namespace to remove the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")

    • addColumnAcl

      public int addColumnAcl​(String group, String ns, String table, String columns, String acl)
      Description copied from interface: DbAclWriter
      Adds a Column ACL entry. No ACL entry may currently exist for the group and table in question.
      Specified by:
      addColumnAcl in interface DbAclWriter
      Parameters:
      group - the group to add the entry for
      ns - the namespace to add the entry for ("*" for all namespaces)
      table - the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")
      columns - the columns the ACL applies to
      acl - the ACL to add, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29
      Returns:
      the number of rows within the ACL database that were modified.

    • updateColumnAcl

      public int updateColumnAcl​(String group, String ns, String table, String columns, String acl)
      Description copied from interface: DbAclWriter
      Changes an already existent Column ACL entry. An ACL entry must currently exist for the group, table, and column set in question.
      Specified by:
      updateColumnAcl in interface DbAclWriter
      Parameters:
      group - the group to update the entry for
      ns - the namespace to update the entry for ("*" for all namespaces)
      table - the namespace to update the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")
      columns - the columns the ACL applies to
      acl - the new ACL, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29
      Returns:
      the number of rows within the ACL database that were modified.

    • deleteColumnAcls

      public void deleteColumnAcls​(String group, String ns, String table, String columns)
      Description copied from interface: DbAclWriter
      Deletes a Column ACL entry for a group, table, and column set.
      Specified by:
      deleteColumnAcls in interface DbAclWriter
      Parameters:
      group - the group to remove the entry for
      ns - the namespace to add the entry for ("*" for all namespaces)
      table - the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")
      columns - the applicable columne set

    • addSystemAcl

      public int addSystemAcl​(String group, String key, String acl)
      Description copied from interface: DbAclWriter
      Adds a system ACL entry. No ACL entry may currently exist for the group and key in question.
      Specified by:
      addSystemAcl in interface DbAclWriter
      Parameters:
      group - the group to add the entry for
      key - the key to add the entry for (wildcard not allowed)
      acl - the ACL to add, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29
      Returns:
      the number of rows within the ACL database that were modified.

    • updateSystemAcl

      public int updateSystemAcl​(String group, String key, String acl)
      Description copied from interface: DbAclWriter
      Changes an already existent system ACL entry. An ACL entry must currently exist for the group and key in question.
      Specified by:
      updateSystemAcl in interface DbAclWriter
      Parameters:
      group - the group to update the entry for
      key - the key to update the entry for (no wildcard)
      acl - the new ACL, see http://wiki.illumon.com/Iris/Permissions#Table_Access_Control_Lists_.28ACLs.29
      Returns:
      the number of rows within the ACL database that were modified.

    • deleteSystemAcls

      public void deleteSystemAcls​(String group, String key)
      Description copied from interface: DbAclWriter
      Deletes a system ACL entry for a group and key.
      Specified by:
      deleteSystemAcls in interface DbAclWriter
      Parameters:
      group - the group to remove the entry for
      key - the namespace to add the entry for (wildcard not allowed)

    • addInputTableEditor

      public int addInputTableEditor​(String group, String ns, String table, boolean canEdit)
      Description copied from interface: DbAclWriter
      Adds an entry to the ACL database for editing an input table.
      Specified by:
      addInputTableEditor in interface DbAclWriter
      Parameters:
      group - the group to add the entry for
      ns - the namespace to add the entry for ("*" for all namespaces)
      table - the namespace to add the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")
      canEdit - whether the table is editable for this group
      Returns:
      the number of rows within the ACL database that were modified.

    • updateInputTableEditor

      public int updateInputTableEditor​(String group, String ns, String table, boolean canEdit)
      Description copied from interface: DbAclWriter
      Updates an entry to the ACL database for editing an input table.
      Specified by:
      updateInputTableEditor in interface DbAclWriter
      Parameters:
      group - the group to update the entry for
      ns - the namespace to update the entry for ("*" for all namespaces)
      table - the namespace to update the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")
      canEdit - whether the table is editable for this group
      Returns:
      the number of rows within the ACL database that were modified.

    • deleteInputTableEditor

      public void deleteInputTableEditor​(String group, String ns, String table)
      Description copied from interface: DbAclWriter
      Deletes an entry to the ACL database for editing an input table.
      Specified by:
      deleteInputTableEditor in interface DbAclWriter
      Parameters:
      group - the group to delete the entry for
      ns - the namespace to delete the entry for ("*" for all namespaces)
      table - the namespace to delete the entry for ("*" for tables within a namespace, if ns is "*" table must also be "*")

    • addOrUpdateSystemUserAcl

      public int addOrUpdateSystemUserAcl​(String user, String systemUser)
      Description copied from interface: DbAclWriter
      Inserts or Updates an entry to the ACL database for run-as mapping
      Specified by:
      addOrUpdateSystemUserAcl in interface DbAclWriter
      Parameters:
      user - the user whose system-user mapping is to be updated
      systemUser - the system-user which will be used for launching workers
      Returns:
      the number of rows within the ACL database that were modified

    • deleteSystemUserAcl

      public void deleteSystemUserAcl​(String user)
      Description copied from interface: DbAclWriter
      Removes an entry from the ACL database for run-as mapping
      Specified by:
      deleteSystemUserAcl in interface DbAclWriter
      Parameters:
      user - the user whose system-user mapping is to be deleted