Some macros support Parameter Restrictions, offering a means to apply more granular restrictions. The Macro Security Managed Macros page details which macros support Parameter Restrictions and the parameters that are available.

For instance, the SQL macro supports the following Parameter Restrictions in addition to the "sql =" Use Restriction.

• sql.datasource
• sql.limit
• sql.disableAntiXss
• sql.querytimeout

The SQL macro's documentation explains what each of these parameters accomplishes, but the syntax within the properties file is similar to what is described on the Using Use Restrictions  page.

There are some special caveats about Parameter Restrictions:

1. A Parameter Restriction only applies when the user tries to change the parameter value to something different than the default.
2. If a Parameter Restriction is defined for the limit parameter (available on the SQL, SQL File and SQL Query macros),  it is only put into effect if the user provides a parameter value that is greater than the Limit Rows Processed setting that an administrator sets in the SQL add-on's configuration.

Parameters that are "By Value"

Some of the Parameter Restrictions documented on the Macro Security Managed Macros page are noted as being "(by value)". This allows even more specificity about how the Parameter Restriction is to be applied.

For the SQL macro, only the datasource parameter is "by value." This means that you can add ".*" to the end of the parameter to have it apply to all names (of datasources, in this example) or you can add entries for one or more specific datasource names.

sql.datasource.* = confluence-administrators

sql.datasource.exampledb = confluence-administrators
sql.datasource.hr = hr-managers

How Parameter Restrictions Work with Use Restrictions

The Parameter Restrictions are applied "on top" of the Use Restriction for that macro. In other words, unless the Trusted Spaces approach for macro security is being used, an "edit" page restriction must match (only) whatever userids and/or group names are referenced in both the Use Restriction condition and the Parameter Restriction.

The following table provides some examples of correct and incorrect combinations. In these examples, assume that userid "bswift" is not a member of any of the named groups.

Properties File "edit" Page Restriction(s) on page using the SQL macro Result (=Valid, =Invalid) 1 sql = *ANY sql.limit = confluence-administrators confluence-administrators 2 sql = *ANY sql.limit = confluence-administrators bswift confluence-administrators because userid "bswift" isn't listed in the SQL entries in the properties file nor is that user a member of the confluence-administrators group 3 sql = *ANY sql.datasource.exampledb = confluence-administrators sql.datasource.hr = hr-managers confluence-administrators hr-managers The 1st edit restriction must be present if the "exampledb" datasource is used. The 2nd edit restriction must be present if the "hr" datasource is used. You could have both of these edit restrictions in place as well. Note too that the Use Restriction (sql = *ANY in this example) must be one of the following in order to support the 2 sql.datasource Parameter Restrictions listed: sql = *ANY sql = confluece-administrators, hr-managers   4 sql-query = *ANY sql-query.datasource.* = confluence-administrators sql-query.datasource.hr = hr-managers sql-query.datasource.finance = finance-managers confluence-administrators hr-managers finance-managers The 1st edit restriction must be present if a datasource other than "hr" and "finance" is used. The 2nd edit restriction must be present if the "hr" datasource is used. The 3rd edit restriction must be present if the finance" datasource is used. You could have all of these edit restrictions in place as well. This example shows how to give access to all datasources to confluence-administrators and also give specific datasource access to different groups. 5 sql = confluence-administrators, trusted-users-sql sql.limit = confluence-administrators

confluence-administrators trusted-users-sql  6 sql = confluence-administrators, space:DEMO  If page is in the DEMO space: "edit" page restrictions are not necessary. Space-level permissions should ensure only trusted users and groups can edit pages, blog posts and comments in that space, however this is not validated by Macro Security.  7 sql = confluence-administrators, space:DEMO  If page is in the DEMO space: bswift  8 sql = confluence-administrators, space:DEMO  If page is not in the DEMO space: confluence-administrators  9 sql = confluence-administrators, space:DEMO  If page is not in the DEMO space: no "edit" page restrictions OR bswift because confluence-administrators is not referenced in "edit" page restrictions

Image Removed

Image Added