Middleware secure

Enable secure interceptor/middleware for the server.

Installation

go get github.com/rookie-ninja/rk-boot/gin

General options

These are general options to start a gin server with rk-boot

name description type default value
gin.name The name of gin server string N/A
gin.port The port of gin server integer nil, server won’t start
gin.enabled Enable gin entry bool false
gin.description Description of gin entry. string ""

Secure options

name description type default value
gin.interceptors.secure.enabled Enable secure interceptor boolean false
gin.interceptors.secure.xssProtection X-XSS-Protection header value. string “1; mode=block”
gin.interceptors.secure.contentTypeNosniff X-Content-Type-Options header value. string nosniff
gin.interceptors.secure.xFrameOptions X-Frame-Options header value. string SAMEORIGIN
gin.interceptors.secure.hstsMaxAge Strict-Transport-Security header value. int 0
gin.interceptors.secure.hstsExcludeSubdomains Excluding subdomains of HSTS. bool false
gin.interceptors.secure.hstsPreloadEnabled Enabling HSTS preload. bool false
gin.interceptors.secure.contentSecurityPolicy Content-Security-Policy header value. string ""
gin.interceptors.secure.cspReportOnly Content-Security-Policy-Report-Only header value. bool false
gin.interceptors.secure.referrerPolicy Referrer-Policy header value. string ""
gin.interceptors.secure.ignorePrefix Ignoring path prefix. []string []

Quick start

1.Create boot.yaml

---
gin:
  - name: greeter                     # Required
    port: 8080                        # Required
    enabled: true                     # Required
    commonService:
      enabled: true                   # Optional, default: false
    interceptors:
      secure:
        enabled: true                 # Optional, default: false

2.Create main.go

// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.
package main

import (
	"context"
	"github.com/rookie-ninja/rk-boot"
	_ "github.com/rookie-ninja/rk-boot/gin"
)

// Application entrance.
func main() {
	// Create a new boot instance.
	boot := rkboot.NewBoot()

	// Bootstrap
	boot.Bootstrap(context.Background())

	// Wait for shutdown sig
	boot.WaitForShutdownSig(context.Background())
}

3.Validate

$ curl -vs localhost:8080/rk/v1/healthy
  ...
  < X-Content-Type-Options: nosniff
  < X-Frame-Options: SAMEORIGIN
  < X-Xss-Protection: 1; mode=block
  < Date: Sun, 05 Dec 2021 18:32:24 GMT
  < Content-Length: 17
  <
  ...

Cheers

Last modified January 17, 2022 : Upgrade gin docs based on newest version (4513f9e)