redis

Documentation

Index

• func GetRedisStore(s Store) (err error, rediStore *redistore.RediStore)
• func SetKeyPrefix(s Store, prefix string) error
• type Store
  • func NewStore(size int, network, address, password string, keyPairs ...[]byte) (Store, error)
  • func NewStoreWithDB(size int, network, address, password, DB string, keyPairs ...[]byte) (Store, error)
  • func NewStoreWithPool(pool *redis.Pool, keyPairs ...[]byte) (Store, error)

Functions

func GetRedisStore

func GetRedisStore(s Store) (err error, rediStore *redistore.RediStore)

GetRedisStore retrieves the Redis store from the provided Store interface. It returns an error if the provided Store is not of the expected type.

Parameters:

• s: The Store interface from which to retrieve the Redis store.

Returns:

• err: An error if the provided Store is not of the expected type.
• rediStore: The retrieved Redis store, or nil if there was an error.

func SetKeyPrefix

func SetKeyPrefix(s Store, prefix string) error

SetKeyPrefix sets a key prefix for the given Redis store. It retrieves the Redis store from the provided Store interface and sets the key prefix. If there is an error retrieving the Redis store, it returns the error.

Parameters:

• s: The Store interface from which the Redis store will be retrieved.
• prefix: The key prefix to be set for the Redis store.

Returns:

• error: An error if there is an issue retrieving the Redis store, otherwise nil.

Types

type Store

type Store interface {
	sessions.Store
}

func NewStore

func NewStore(size int, network, address, password string, keyPairs ...[]byte) (Store, error)

size: maximum number of idle connections. network: tcp or udp address: host:port password: redis-password Keys are defined in pairs to allow key rotation, but the common case is to set a single authentication key and optionally an encryption key.

The first key in a pair is used for authentication and the second for encryption. The encryption key can be set to nil or omitted in the last pair, but the authentication key is required in all pairs.

It is recommended to use an authentication key with 32 or 64 bytes. The encryption key, if set, must be either 16, 24, or 32 bytes to select AES-128, AES-192, or AES-256 modes.

func NewStoreWithDB

func NewStoreWithDB(size int, network, address, password, DB string, keyPairs ...[]byte) (Store, error)

NewStoreWithDB creates a new Redis-based session store with the specified parameters.

Parameters: - size: The maximum number of idle connections in the pool. - network: The network type (e.g., "tcp"). - address: The address of the Redis server (e.g., "localhost:6379"). - password: The password for the Redis server (if any). - DB: The Redis database to be selected after connecting. - keyPairs: A variadic list of byte slices used for authentication and encryption.

Returns: - Store: The created session store. - error: An error if the store could not be created.

func NewStoreWithPool

func NewStoreWithPool(pool *redis.Pool, keyPairs ...[]byte) (Store, error)

NewStoreWithPool creates a new session store using a Redis connection pool. It takes a redis.Pool and an optional variadic list of key pairs for authentication and encryption of session data.

Parameters:

• pool: A redis.Pool object that manages a pool of Redis connections.
• keyPairs: Optional variadic list of byte slices used for authentication and encryption of session data.

Returns:

• Store: A new session store backed by Redis.
• error: An error if the store could not be created.