When a cookie is configured with the HttpOnly attribute set to true, the browser guaranties that no client-side script will
be able to read it. In most cases, when a cookie is created, the default value of HttpOnly is false and it’s up to the developer
to decide whether or not the content of the cookie can be read by the client-side script. As a majority of Cross-Site Scripting (XSS) attacks target
the theft of session-cookies, the HttpOnly attribute can help to reduce their impact as it won’t be possible to exploit the XSS
vulnerability to steal session-cookies.
Ask Yourself Whether
- the cookie is sensitive, used to authenticate the user, for instance a session-cookie
- the
HttpOnly attribute offer an additional protection (not the case for an XSRF-TOKEN cookie / CSRF token for example)
There is a risk if you answered yes to any of those questions.
Recommended Secure Coding Practices
- By default the
HttpOnly flag should be set to true for most of the cookies and it’s mandatory for session /
sensitive-security cookies.
Sensitive Code Example
For Go Standard Library:
import "net/http"
func handler(w http.ResponseWriter, req *http.Request) {
cookie := http.Cookie{}
cookie.Name = "cookiename"
cookie.Value = "cookievalue"
http.SetCookie(w, &cookie) // Sensitive: HttpOnly is false by default
}
For Beego:
import "github.com/beego/beego/v2/server/web"
func (ctrl *MainController) handler() {
ctrl.Ctx.SetCookie("name1", "value1", 200, "/", "example.com", false, false) // Sensitive
}
For Fiber:
import "github.com/gofiber/fiber/v2"
func handler(c *fiber.Ctx) error {
cookie := new(fiber.Cookie)
cookie.Name = "name"
cookie.Value = "value"
c.Cookie(cookie) // Sensitive: HttpOnly is false by default
return c.SendString("")
}
For Gin:
import "github.com/gin-gonic/gin"
func handler(c *gin.Context) {
c.SetCookie("name", "value", 200, "/", "example.com", false, false) // Sensitive
c.JSON(http.StatusOK, gin.H{"message": ""})
}
Compliant Solution
For Go Standard Library:
import "net/http"
func handler(w http.ResponseWriter, req *http.Request) {
cookie := http.Cookie{}
cookie.Name = "cookiename"
cookie.Value = "cookievalue"
cookie.HttpOnly = true
http.SetCookie(w, &cookie)
}
For Beego:
import "github.com/beego/beego/v2/server/web"
func (ctrl *MainController) handler() {
ctrl.Ctx.SetCookie("name1", "value1", 200, "/", "example.com", false, true)
}
For Fiber:
import "github.com/gofiber/fiber/v2"
func handler(c *fiber.Ctx) error {
cookie := new(fiber.Cookie)
cookie.Name = "name"
cookie.Value = "value"
cookie.HTTPOnly = true
c.Cookie(cookie)
return c.SendString("")
}
For Gin:
import "github.com/gin-gonic/gin"
func handler(c *gin.Context) {
c.SetCookie("name", "value", 200, "/", "example.com", false, true)
c.JSON(http.StatusOK, gin.H{"message": ""})
}
See
