222 lines
8.5 KiB
Ruby
222 lines
8.5 KiB
Ruby
module DiasporaFederation
|
|
module Discovery
|
|
# The WebFinger document used for Diaspora* user discovery is based on an older
|
|
# draft of the specification you can find in the wiki of the "webfinger" project
|
|
# on {http://code.google.com/p/webfinger/wiki/WebFingerProtocol Google Code}
|
|
# (from around 2010).
|
|
#
|
|
# In the meantime an actual RFC draft has been in development, which should
|
|
# serve as a base for all future changes of this implementation.
|
|
#
|
|
# @example Creating a WebFinger document from a person hash
|
|
# wf = WebFinger.new(
|
|
# acct_uri: "acct:user@server.example",
|
|
# alias_url: "https://server.example/people/0123456789abcdef",
|
|
# hcard_url: "https://server.example/hcard/users/user",
|
|
# seed_url: "https://server.example/",
|
|
# profile_url: "https://server.example/u/user",
|
|
# atom_url: "https://server.example/public/user.atom",
|
|
# salmon_url: "https://server.example/receive/users/0123456789abcdef",
|
|
# guid: "0123456789abcdef",
|
|
# public_key: "-----BEGIN PUBLIC KEY-----\nABCDEF==\n-----END PUBLIC KEY-----"
|
|
# )
|
|
# xml_string = wf.to_xml
|
|
#
|
|
# @example Creating a WebFinger instance from an xml document
|
|
# wf = WebFinger.from_xml(xml_string)
|
|
# ...
|
|
# hcard_url = wf.hcard_url
|
|
# ...
|
|
#
|
|
# @see http://tools.ietf.org/html/draft-jones-appsawg-webfinger "WebFinger" -
|
|
# current draft
|
|
# @see http://code.google.com/p/webfinger/wiki/CommonLinkRelations
|
|
# @see http://www.iana.org/assignments/link-relations/link-relations.xhtml
|
|
# official list of IANA link relations
|
|
class WebFinger < Entity
|
|
# @!attribute [r] acct_uri
|
|
# The Subject element should contain the webfinger address that was asked
|
|
# for. If it does not, then this webfinger profile MUST be ignored.
|
|
# @return [String]
|
|
property :acct_uri
|
|
|
|
# @!attribute [r] alias_url
|
|
# @return [String] link to the users profile
|
|
property :alias_url
|
|
|
|
# @!attribute [r] hcard_url
|
|
# @return [String] link to the +hCard+
|
|
property :hcard_url
|
|
|
|
# @!attribute [r] seed_url
|
|
# @return [String] link to the pod
|
|
property :seed_url
|
|
|
|
# @!attribute [r] profile_url
|
|
# @return [String] link to the users profile
|
|
property :profile_url
|
|
|
|
# @!attribute [r] atom_url
|
|
# This atom feed is an Activity Stream of the user's public posts. Diaspora
|
|
# pods SHOULD publish an Activity Stream of public posts, but there is
|
|
# currently no requirement to be able to read Activity Streams.
|
|
# @see http://activitystrea.ms/ Activity Streams specification
|
|
#
|
|
# Note that this feed MAY also be made available through the PubSubHubbub
|
|
# mechanism by supplying a <link rel="hub"> in the atom feed itself.
|
|
# @return [String] atom feed url
|
|
property :atom_url
|
|
|
|
# @!attribute [r] salmon_url
|
|
# @return [String] salmon endpoint url
|
|
# @see http://salmon-protocol.googlecode.com/svn/trunk/draft-panzer-salmon-00.html#SMLR
|
|
# Panzer draft for Salmon, paragraph 3.3
|
|
property :salmon_url
|
|
|
|
# @!attribute [r] guid
|
|
# @deprecated Either convert these to +Property+ elements or move to the
|
|
# +hCard+, which actually has fields for an +UID+ defined in the +vCard+
|
|
# specification (will affect older Diaspora* installations).
|
|
#
|
|
# @see HCard#guid
|
|
#
|
|
# This is just the guid. When a user creates an account on a pod, the pod
|
|
# MUST assign them a guid - a random hexadecimal string of at least 8
|
|
# hexadecimal digits.
|
|
# @return [String] guid
|
|
property :guid
|
|
|
|
# @!attribute [r] public_key
|
|
# @deprecated Either convert these to +Property+ elements or move to the
|
|
# +hCard+, which actually has fields for an +KEY+ defined in the +vCard+
|
|
# specification (will affect older Diaspora* installations).
|
|
#
|
|
# @see HCard#pubkey
|
|
#
|
|
# When a user is created on the pod, the pod MUST generate a pgp keypair
|
|
# for them. This key is used for signing messages. The format is a
|
|
# DER-encoded PKCS#1 key beginning with the text
|
|
# "-----BEGIN PUBLIC KEY-----" and ending with "-----END PUBLIC KEY-----".
|
|
# @return [String] public key
|
|
property :public_key
|
|
|
|
# +hcard_url+ link relation
|
|
REL_HCARD = "http://microformats.org/profile/hcard"
|
|
|
|
# +seed_url+ link relation
|
|
REL_SEED = "http://joindiaspora.com/seed_location"
|
|
|
|
# @deprecated This should be a +Property+ or moved to the +hCard+, but +Link+
|
|
# is inappropriate according to the specification (will affect older
|
|
# Diaspora* installations).
|
|
# +guid+ link relation
|
|
REL_GUID = "http://joindiaspora.com/guid"
|
|
|
|
# +profile_url+ link relation.
|
|
# @note This might just as well be an +Alias+ instead of a +Link+.
|
|
REL_PROFILE = "http://webfinger.net/rel/profile-page"
|
|
|
|
# +atom_url+ link relation
|
|
REL_ATOM = "http://schemas.google.com/g/2010#updates-from"
|
|
|
|
# +salmon_url+ link relation
|
|
REL_SALMON = "salmon"
|
|
|
|
# @deprecated This should be a +Property+ or moved to the +hcard+, but +Link+
|
|
# is inappropriate according to the specification (will affect older
|
|
# Diaspora* installations).
|
|
# +pubkey+ link relation
|
|
REL_PUBKEY = "diaspora-public-key"
|
|
|
|
# Create the XML string from the current WebFinger instance
|
|
# @return [String] XML string
|
|
def to_xml
|
|
doc = XrdDocument.new
|
|
doc.subject = @acct_uri
|
|
doc.aliases << @alias_url
|
|
|
|
add_links_to(doc)
|
|
|
|
doc.to_xml
|
|
end
|
|
|
|
# Create a WebFinger instance from the given XML string.
|
|
# @param [String] webfinger_xml WebFinger XML string
|
|
# @return [WebFinger] WebFinger instance
|
|
# @raise [InvalidData] if the given XML string is invalid or incomplete
|
|
def self.from_xml(webfinger_xml)
|
|
data = parse_xml_and_validate(webfinger_xml)
|
|
|
|
links = data[:links]
|
|
|
|
# TODO: remove! public key is deprecated in webfinger
|
|
public_key = parse_link(links, REL_PUBKEY)
|
|
|
|
new(
|
|
acct_uri: data[:subject],
|
|
alias_url: data[:aliases].first,
|
|
hcard_url: parse_link(links, REL_HCARD),
|
|
seed_url: parse_link(links, REL_SEED),
|
|
profile_url: parse_link(links, REL_PROFILE),
|
|
atom_url: parse_link(links, REL_ATOM),
|
|
salmon_url: parse_link(links, REL_SALMON),
|
|
|
|
# TODO: remove me! ##########
|
|
guid: parse_link(links, REL_GUID),
|
|
public_key: (Base64.strict_decode64(public_key) if public_key)
|
|
)
|
|
end
|
|
|
|
private
|
|
|
|
# Parses the XML string to a Hash and does some rudimentary checking on
|
|
# the data Hash.
|
|
# @param [String] webfinger_xml WebFinger XML string
|
|
# @return [Hash] data XML data
|
|
# @raise [InvalidData] if the given XML string is invalid or incomplete
|
|
def self.parse_xml_and_validate(webfinger_xml)
|
|
XrdDocument.xml_data(webfinger_xml).tap do |data|
|
|
valid = data.key?(:subject) && data.key?(:aliases) && data.key?(:links)
|
|
raise InvalidData, "webfinger xml is incomplete" unless valid
|
|
end
|
|
end
|
|
private_class_method :parse_xml_and_validate
|
|
|
|
def add_links_to(doc)
|
|
doc.links << {rel: REL_HCARD,
|
|
type: "text/html",
|
|
href: @hcard_url}
|
|
doc.links << {rel: REL_SEED,
|
|
type: "text/html",
|
|
href: @seed_url}
|
|
|
|
# TODO: remove me! ##############
|
|
doc.links << {rel: REL_GUID,
|
|
type: "text/html",
|
|
href: @guid}
|
|
##################################
|
|
|
|
doc.links << {rel: REL_PROFILE,
|
|
type: "text/html",
|
|
href: @profile_url}
|
|
doc.links << {rel: REL_ATOM,
|
|
type: "application/atom+xml",
|
|
href: @atom_url}
|
|
doc.links << {rel: REL_SALMON,
|
|
href: @salmon_url}
|
|
|
|
# TODO: remove me! ##############
|
|
doc.links << {rel: REL_PUBKEY,
|
|
type: "RSA",
|
|
href: Base64.strict_encode64(@public_key)}
|
|
##################################
|
|
end
|
|
|
|
def self.parse_link(links, rel)
|
|
element = links.find {|l| l[:rel] == rel }
|
|
element ? element[:href] : nil
|
|
end
|
|
private_class_method :parse_link
|
|
end
|
|
end
|
|
end
|