Skip to content

mrhaki/grails-x-frame-options-plugin

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Grails X-Frame-Options Plugin

Filter to set HTTP response header X-Frame-Options to defend against ClickJacking.

More information about using X-Frame-Options for defending against clickjacking:

Installation

These instructions are targeted towards Grails 3 installations. For Grails 2.x refer to branch 1.x of the plugin.

Add a dependency to build.gradle:

...
dependencies {
    ...
    runtime ('org.grails.plugins:x-frame-options:1.1.2')
    ...
}
...

The default configuration installs a servlet filter for the URL pattern /* that adds a response header X-Frame-Options with the value DENY.

Configuration

The plugin is configured through grails-app/conf/application.yml.

We can limit the URL pattern the filter is applied to:

grails:
    plugin:
        xframeoptions:
            urlPattern: /path/*

We can also set multiple patterns:

grails:
    plugin:
        xframeoptions:
            urlPattern:
                - /path/*
                - /other/*

We can set different header values based on the configuration. To set the header value DENY we must use the following configuration:

grails:
    plugin:
        xframeoptions:
            deny: true

This is also the default value if no configuration is provided or no configuration options are set.

To set the header value SAMEORIGIN we must use the following configuration:

grails:
    plugin:
        xframeoptions:
            sameOrigin: true

To set the header value ALLOW-FROM with a URL we must use the following configuration:

grails:
    plugin:
        xframeoptions:
            allowFrom: http://www.mrhaki.com

To disable the filter we must use the following configuration option:

grails:
    plugin:
        xframeoptions:
            enabled: false

The filter is enabled by default and will use the DENY header value.

About

Servlet filter that adds an X-Frame-Options response header to defend against clickjacking.

Resources

Stars

Watchers

Forks

Packages

No packages published