Help Center

Menu

security.earlybinding.user-to-key-mapper

Background

This setting applies to document level security. It sets the method ussd to obtain the user’s keys and is used at query time to map a given username into a list of keys which the user can use to unlock documents (usually group or permission names). Possible values are:

  • Meta: This option must be set in the search package configuration for any search that utilizes document level security. This option will delegate the key mapping to the mapping configured in the corresponding data source for the result being processed.

  • Portal : This option will retrieve the user keys from a URL parameter named userkeys (e.g. http://search.example.com/s/search?collection=…​&userkeys=key1,key2). Note that this approach is not secure unless Funnelback can be accessed only through a portal, so that users cannot change the value of the userkeys parameter. Keys can be passed using a different parameter, or a HTTP header when used in conjunction with the Map URLs plugin.

  • MasterKey: Special plugin used for testing: It will always pass a generic master key that will grant access to every document. Do not use in production!.

Setting the key

Set this configuration key in the search package or data source configuration.

Use the configuration key editor to add or edit the security.earlybinding.user-to-key-mapper key, and set the value. This can be set to any valid UserToKeyMapperTypes allowed values: MasterKey, Meta, Trim, Trim2, Groovy, Portal, ManifoldCF, ManifoldCFDebug, Sitecore or Moodle value.

Default value

(None)

Examples

Use the Portal user to key mapper:

security.earlybinding.user-to-key-mapper=Portal