Hand-Crafting My FOAF

While at eTech, I attended a number of "social software" sessions. One thing I heard was a persistent call from folk like Marc Canter for all the vendors to support something called FOAF. FOAF is a standard for "Friend of a Friend" files, and is an attempt to make machine readable information about people, groups, companies, and other online resources. In particular, it is focused on representing the information that you might typically put on your personal home page in a form such that meta-data tools can interpret it.

If you are using the blog service TypePad or the social networking service Ecademy you may already have a FOAF file without knowing it, and Tribe.Net announced at eTech that they were promising to support it as well for their social networking service.

FOAF as a standard is still in a fairly primitive state -- to me it feels like HTML did during the days of the early Mosaic browser, when every good web page had to be hand-crafted in a text editor and uploaded to a server. However, like HTML, it may have great promise.

The first thing that FOAF may offer us is a way to exchange information between various social networking services. For instance, I just exported all my Orkut friends into my own FOAF file by hand, but there are those who are working on tools to do this automatically, and once Tribe offers FOAF, services like Orkut may be forced to do the same.

Probably more important in the long run is that FOAF may decentralize the data that you make public about yourself -- to put the data under your own control. Owned by you rather then owned by the services you use. For instance, many people have complained about Orkut's ownership of information.

The biggest problem with FOAF right now is that it doesn't support very much "progressive disclosure" or privacy. Progressive disclosure is how people typically handle private information -- they disclose information about themselves a bit at a time, and as trust builds, offer more. The only small measure of privacy that FOAF has is that it has a way to obscure email addresses so that they can't easily be harvested by spammers. But all your other information is totally public. Theoretically you can encrypt your FOAF file, but this method requires external PGP-based encrypted files. There is also the possibility of XML-DSIG, however, I find this standard to also be extremely cumbersome right now. Plaxo is a major social networking service that has some excellent comments on FOAF privacy and other issues.

What I want is something that allows people to make 'local' assertions about themselves and their friends, and be able to have those friends be able to 'discover' more information by using those assertions. Ron Rivest came out with an interesting method for this in an old project called SDSI - A Simple Distributed Security Infrastructure that I hope will inspire a few FOAF architects someday. To adopt his method for FOAF requires everyone to have a FOAF service script somewhere and not just a data file. But we've seen broad adoption of personal RSS and Trackback services, so I don't think this is a huge obstacle to overcome.

In the meantime, if you want to play around with FOAF take over control of your own public data, I've included detailed information on how to get started in hand-crafting your own FOAF file.

Hand-Crafting your own FOAF

First, start with FOAF-a-Matic. This is a web form page that will create a very simple starting FOAF file for you. Don't put any information in it that you don't want to be public, and skip the section on "people you know". When it asks for your email address, make sure to enter it in all lower-case. When completed, it will look something like this:

<rdf:RDF
  xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
  xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
  xmlns:foaf="http://xmlns.com/foaf/0.1/">
  <foaf:Person>
    <foaf:name>Christopher Allen</foaf:name>
    <foaf:title>Mr</foaf:title>
    <foaf:firstName>Christopher</foaf:firstName>
    <foaf:surname>Allen</foaf:surname>
    <foaf:nick>Chris</foaf:nick>
    <foaf:mbox_sha1sum>9ee1c03552f22e89592ce583be0ab8db0c4f2c59</foaf:mbox_sha1sum>
    <foaf:homepage rdf:resource="http://www.alacrityventures.com/allen.html"/>
    <foaf:depiction
      rdf:resource="http://web.lifewithalacrity.com/christophera/images/ChristopherAllen(100x100).gif"/>
    <foaf:workplaceHomepage rdf:resource="http://www.alacrityventures.com"/>
    <foaf:workInfoHomepage rdf:resource="http://www.alacrityventures.com/allen.html"/>
  </foaf:Person>
</rdf:RDF>

The next thing is to add pointers to any other FOAF files that you might have on other services, for instance, I have a profile on Marc Canter's People Aggregator service. You should also list the place where you plan on making your FOAF file available -- you might think that this is a circular reference, but it is OK. My convention is to put the most "authoritative" FOAF file last, so that if there is a conflict the last one might override earlier ones. However, in practice I've not found that any FOAF tool I've used supports this convention. Put these right above the closing </foaf:Person> tag.

  <rdfs:seeAlso rdf:resource="http://peopleaggregator.com/profile?id=102" />
  <rdfs:seeAlso rdf:resource="http://www.ecademy.com/module.php?mod=network&amp;op=foafrdf&amp;uid=42230" />
  <rdfs:seeAlso rdf:resource="http://web.lifewithalacrity.com/christophera/foaf.rdf" />

Now upload your file to your own web site, and then run your FOAF file through two different validators, the first being the W3C RDF Validation Service. It will tell you if you've made any mistakes with the RDF aspect of the file. Then use Rosco which will also look at your schema and make recommendations as to missing items. Unfortunately, neither validator is very good at telling you what the problem is if it finds one -- again, it is like the old hand-coding HTML days when you are debugging your web pages.

Once you've got your basic FOAF file working, now to enter your friends. First, add to your foaf:Person the following:

<foaf:knows rdf:nodeID="MarcCanter"/>

This is a pointer that says "look in this document for a person with the rdf:nodeID of MarcCanter". You can invent any value you want for this ID, mcanter, mark, canter, etc., however, it must be a unique ID on this page.

Then fill out the following template for each person, putting below your own foaf:Person but above the closing rdf:RDF tag:

<foaf:Person rdf:nodeID="">
  <foaf:name></foaf:name>
  <foaf:firstname></foaf:name>
  <foaf:surname></foaf:name>
  <foaf:nick></foaf:nick>
  <foaf:mbox_sha1sum></foaf:mbox_sha1sum>
  <rdfs:seeAlso rdf:resource="" />
</foaf:Person>

So for instance with Marc Canter:

<foaf:Person rdf:nodeID="MarcCanter">
  <foaf:name>Marc Canter</foaf:name>
  <foaf:mbox_sha1sum>41e872618d70ba18a7af715083f522afe7fc3238</foaf:mbox_sha1sum>
  <rdfs:seeAlso rdf:resource="http://peopleaggregator.com/profile?id=4" />
</foaf:Person>

Now foaf:firstname, foaf:surname, and foaf:nick are not absolutely essential -- you can remove them if they are not needed. I tend to only use them when there might be some confusion, for instance, for "Arthur De Boies" has "De Boise" is a surname, and "Lori Ann Miller" has "Lori Ann" as a firstname. foaf:nick is useful in situatations where there is a dimunitive involved, for instance "Christopher Allen" has "Chris" as a nick, and foaf:nick is also used by some programs online personas or for IRC chat, such as "ChristopherA".

Now where did the foaf:mbox_sha1sum come from? The purpose of this number is to obscure the email address so that it can't be harvested by spammers, yet is unique enough that it can FOAF-based applications can find people. To convert an email address to a foaf:mbox_sha1sum you can use sha1ify. Just enter the email address that you want converted in all lower case, and copy the string it generates to the foaf:mbox_sha1sum.

Finally, you can search and see if any existing FOAF profiles exist for your friend at FOAF: Web View, using their email address. If the friend does have a FOAF file, add it to rdfs:seeAlso tag.

When you are done, test your FOAF file with the two validators, and if it works. One common problem that the validators will fail to give you a good error message about is if any of the URLs you use contain any improper characters like & - in particular, Ecademy's FOAF files use this character. Just substitute & for every occurrence of & and it should work fine. Another problem is if any of your friends have international characters in their names, for instance "Sébastien". To avoid this problem, put the following at the top of your FOAF file above your rdf:RDF tag.

<?xml version="1.0" encoding="iso-8859-1"?>

Once everything is working you can submit it to services like FOAF: Web View. You can also browse your FOAF file directly by using FOAF Explorer, or import it into services like People Aggregator.

Once your FOAF file is working and submitted, you'll want to add an "auto-discovery" meta-tag to your blog or home page. This is placed in the head portion of your HTML code:

<link rel="meta" type="application/rdf+xml"
  title="FOAF" href="http://web.lifewithalacrity.com/christophera/foaf.rdf"/>

If you are using TypePad, it forces you to use their FOAF file for you unless you used an Advanced Template. With an Advanced Template you can remove the following tags and replace it with the above:

<MTUserIfShow field="foaf">
  <link rel="meta" type="application/rdf+xml" title="FOAF" href="<$MTUserSiteURL$>foaf.rdf" />
  </MTUserIfShow>

From this point on it is just a matter of looking at other people's FOAF files and seeing if you want to add any of the other profile properties that they use. I'm trying to keep a well documented foaf at http://web.lifewithalacrity.com/christophera/foaf.rdf, and I also recommend looking at Morten Frederiksen's FOAF at http://xml.mfd-consult.dk/foaf/morten.rdf which supports far more profile information then my FOAF does.

Also useful is the IRC chat channel at irc.freenode.net #foaf -- I got a lot of useful tips and advice there.

Comments

[Julian Bond]

Please add some notes about how to say that "This foaf file is about this person". See these for detail about PPD, topic, maker, made.
Discussion rdfweb.org/pipermail/rd...-dev/2004-February/thread.html
The post that kicked it off rdfweb.org/pipermail/rd...-dev/2004-February/012546.html
An example www.ecademy.com/module.php

[Morten Frederiksen]

On the encryption issue: FOAFbot supports encrypted FOAF files (per the link), and I've just set up a service for hosting these types of files, so you don't have to encrypt them yourself: http://foaf.dk/hosting/
Of course, that means you have to trust me...

On the ordering of seeAlso: RDF/XML doesn't have a sense of order (unless you use rdf:Seq, as in RSS). In short, you're simply making statements of fact (hopefully!), statements that could stand on their own. There's no default or primary.

[Ben Nolan]

And as with the old html days - there will be end user tools created. My take on an foaf-generation tool for non-technical users is at zopto.com

[elamb]

Blogharbor.com also has a FOAF file. I didn't know it was its own protocol. My FOAF is through Blogware.