Code Monkey home page Code Monkey logo

cookie's Introduction

Cookie

Advanced cookie library for Go, support signed cookies.

Build Status Coverage Status License GoDoc

Features

  1. Lazy: Since cookie verification against multiple keys could be expensive, cookies are only verified lazily when accessed, not eagerly on each request.
  2. Convenient: Signed cookies are stored the same way as unsigned cookies. An additional signature cookie is stored for each signed cookie, using a standard naming convention (cookie-name.sig). This allows other libraries to access the original cookies without having to know the signing mechanism.
  3. compatibility for https://github.com/pillarjs/cookies

API

cookie.New(w http.ResponseWriter, r *http.Request[, keys ...string])

It returns a Cookies instance with optional keygrip for signed cookies.

cookies.Set(name, val string[, opts *Options])

It set the given cookie to the response and returns the current context to allow chaining. If options omit, it will use default options.

Options:

  • MaxAge: a number representing the milliseconds for expiry (default to 0)
  • Path: a string indicating the path of the cookie (default to "/").
  • Domain: a string indicating the domain of the cookie (default to "").
  • Secure: a boolean indicating whether the cookie is only to be sent over HTTP(S) (default to false).
  • HTTPOnly: a boolean indicating whether the cookie is only to be sent over HTTP(S) (default to true).
  • Signed: a boolean indicating whether the cookie is to be signed (default to false). If this is true, another cookie of the same name with the .sig suffix appended will also be sent.

cookies.Get(name string[, signed bool])

It returns the cookie with the given name from the Cookie header in the request. If such a cookie exists, its value is returned. Otherwise, nothing is returned. signed = true can optionally be passed as the second parameter. In this case, a signature cookie (a cookie of same name ending with the .sig suffix appended) is fetched. If the signature cookie does exist, cookie will check the hash of cookie-value whether matches registered keys.

Example

package main

import (
  "net/http"

  "github.com/go-http-utils/cookie"
)

func main() {
  http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
    cookies := cookie.New(w, r, "some key")

    cookies.Set("test", "some cookie", &cookie.Options{
      Signed:   true,
      HTTPOnly: true,
    })

    value, err := cookies.Get("test", true)
    if err != nil {
      w.WriteHeader(500)
      w.Write([]byte(err.Error()))
    } else {
      w.Write([]byte(value))
    }
  })

  http.ListenAndServe(":8080", nil)
}

cookie's People

Contributors

mushroomsir avatar zensh avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

presleyhank

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.