class OpenID::Store::Memcache

Attributes

Public Class Methods

new (cache_client, key_prefix='openid-store:')

Source

# File lib/openid/store/memcache.rb, line 11
def initialize(cache_client, key_prefix='openid-store:')
  @cache_client = cache_client
  self.key_prefix = key_prefix
end

Public Instance Methods

assoc_key (server_url, assoc_handle=nil)

Source

# File lib/openid/store/memcache.rb, line 73
def assoc_key(server_url, assoc_handle=nil)
  key = key_prefix + 'A' + server_url
  if assoc_handle
    key += '|' + assoc_handle
  end
  return key
end

cleanup ()

Source

# File lib/openid/store/memcache.rb, line 84
def cleanup
end

cleanup_associations ()

Source

# File lib/openid/store/memcache.rb, line 87
def cleanup_associations
end

cleanup_nonces ()

Source

# File lib/openid/store/memcache.rb, line 81
def cleanup_nonces
end

get_association (server_url, handle=nil)

Source

# File lib/openid/store/memcache.rb, line 32
def get_association(server_url, handle=nil)
  serialized = @cache_client.get(assoc_key(server_url, handle))
  if serialized
    return deserialize(serialized)
  else
    return nil
  end
end

Returns a Association object from storage that matches the server_url. Returns nil if no such association is found or if the one matching association is expired. (Is allowed to GC expired associations when found.)

remove_association (server_url, handle)

Source

# File lib/openid/store/memcache.rb, line 43
def remove_association(server_url, handle)
  deleted = delete(assoc_key(server_url, handle))
  server_assoc = get_association(server_url)
  if server_assoc && server_assoc.handle == handle
    deleted = delete(assoc_key(server_url)) | deleted
  end
  return deleted
end

If there is a matching association, remove it from the store and return true, otherwise return false.

store_association (server_url, association)

Source

# File lib/openid/store/memcache.rb, line 20
def store_association(server_url, association)
  serialized = serialize(association)
  [nil, association.handle].each do |handle|
    key = assoc_key(server_url, handle)
    @cache_client.set(key, serialized, expiry(association.lifetime))
  end
end

Put a Association object into storage. When implementing a store, don’t assume that there are any limitations on the character set of the server_url. In particular, expect to see unescaped non-url-safe characters in the server_url field.

use_nonce (server_url, timestamp, salt)

Source

# File lib/openid/store/memcache.rb, line 61
def use_nonce(server_url, timestamp, salt)
  return false if (timestamp - Time.now.to_i).abs > Nonce.skew
  ts = timestamp.to_s # base 10 seconds since epoch
  nonce_key = key_prefix + 'N' + server_url + '|' + ts + '|' + salt
  result = @cache_client.add(nonce_key, '', expiry(Nonce.skew + 5))
  if result.is_a? String
    return !!(result =~ /^STORED/)
  else
    return !!(result)
  end
end

Return true if the nonce has not been used before, and store it for a while to make sure someone doesn’t try to use the same value again. Return false if the nonce has already been used or if the timestamp is not current. You can use OpenID::Store::Nonce::SKEW for your timestamp window. server_url: URL of the server from which the nonce originated timestamp: time the nonce was created in seconds since unix epoch salt: A random string that makes two nonces issued by a server in

the same second unique

Protected Instance Methods

delete (key)

Source

# File lib/openid/store/memcache.rb, line 92
def delete(key)
  result = @cache_client.delete(key)
  if result.is_a? String
    return !!(result =~ /^DELETED/)
  else
    return !!(result)
  end
end

deserialize (assoc_str)

Source

# File lib/openid/store/memcache.rb, line 105
def deserialize(assoc_str)
  Marshal.load(assoc_str)
end

expiry (t)

Source

# File lib/openid/store/memcache.rb, line 110
def expiry(t)
  Time.now.to_i + t
end

Convert a lifetime in seconds into a memcache expiry value

serialize (assoc)

Source

# File lib/openid/store/memcache.rb, line 101
def serialize(assoc)
  Marshal.dump(assoc)
end