Re: [OAUTH-WG] application/x-www-form-urlencoded vs JSON

David Recordon <recordond@gmail.com> Tue, 20 April 2010 19:45 UTC

Return-Path: <recordond@gmail.com>
X-Original-To: oauth@core3.amsl.com
Delivered-To: oauth@core3.amsl.com
Received: from localhost (localhost [127.0.0.1]) by core3.amsl.com (Postfix) with ESMTP id D91EA28C156 for <oauth@core3.amsl.com>; Tue, 20 Apr 2010 12:45:21 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.599
X-Spam-Level:
X-Spam-Status: No, score=-2.599 tagged_above=-999 required=5 tests=[BAYES_00=-2.599]
Received: from mail.ietf.org ([64.170.98.32]) by localhost (core3.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id o2Y9rkVtjGn7 for <oauth@core3.amsl.com>; Tue, 20 Apr 2010 12:45:20 -0700 (PDT)
Received: from mail-pv0-f172.google.com (mail-pv0-f172.google.com [74.125.83.172]) by core3.amsl.com (Postfix) with ESMTP id C0FE73A6765 for <oauth@ietf.org>; Tue, 20 Apr 2010 12:45:20 -0700 (PDT)
Received: by pvf33 with SMTP id 33so4293723pvf.31 for <oauth@ietf.org>; Tue, 20 Apr 2010 12:45:07 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:in-reply-to:references :date:received:message-id:subject:from:to:cc:content-type :content-transfer-encoding; bh=4zzBih7liof4NqlnLky0Rz3lzhBFkiyCha99pb5Usyw=; b=jaxNgPjXA4SorKaAzBTDpFX6Zd+ySrbGm103ZHund8aE6wRuuwxyiR0/bcROt6oI7z cR6QTlQj9mvd7NHLQoMrb/nOTbtSzIuavxv752YqDZLgS96Pfl1FJ3UQ4zeBEUszG+7K zgIdq9Q/c3JTJEBdI63etVIIvJ1vvyLEulmao=
DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type:content-transfer-encoding; b=OaINf0FeRtUS92qusXeAgbEfjmCySyN6A4FT0ItcuSUKLjieBnJYX2jt49pEb/fjeP smgpoOm6XCOYY4pp8Oki+qidM7wj9ajerXQ24KGi5atdJ4KwpoMBrGOlAECiKTq2rTuA eVHWmm8Ccqs6xhl8xssXtXPk0bkxd02I8ZFGM=
MIME-Version: 1.0
Received: by 10.231.182.196 with HTTP; Tue, 20 Apr 2010 12:45:05 -0700 (PDT)
In-Reply-To: <t2wc334d54e1004200924ja0e7786u9b349a1931098f2a@mail.gmail.com>
References: <9890332F-E759-4E63-96FE-DB3071194D84@gmail.com> <90C41DD21FB7C64BB94121FBBC2E723438E30A379B@P3PW5EX1MB01.EX1.SECURESERVER.NET> <20100419134825.134951nuzvi35hk4@webmail.df.eu> <90C41DD21FB7C64BB94121FBBC2E723438E5C7F45E@P3PW5EX1MB01.EX1.SECURESERVER.NET> <t2wc334d54e1004200924ja0e7786u9b349a1931098f2a@mail.gmail.com>
Date: Tue, 20 Apr 2010 12:45:05 -0700
Received: by 10.114.237.3 with SMTP id k3mr6168347wah.219.1271792706880; Tue, 20 Apr 2010 12:45:06 -0700 (PDT)
Message-ID: <l2ofd6741651004201245gdfc6e2a3j10a6e8a3e59f2072@mail.gmail.com>
From: David Recordon <recordond@gmail.com>
To: jsmarr@stanfordalumni.org
Content-Type: text/plain; charset="windows-1252"
Content-Transfer-Encoding: quoted-printable
Cc: OAuth WG <oauth@ietf.org>
Subject: Re: [OAUTH-WG] application/x-www-form-urlencoded vs JSON
X-BeenThere: oauth@ietf.org
X-Mailman-Version: 2.1.9
Precedence: list
List-Id: OAUTH WG <oauth.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/listinfo/oauth>, <mailto:oauth-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/oauth>
List-Post: <mailto:oauth@ietf.org>
List-Help: <mailto:oauth-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/oauth>, <mailto:oauth-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 20 Apr 2010 19:45:21 -0000

Having written an implementation last night against the web server
flow, I'm worried about adding JSON as a requirement for the response.
While it might be easier for environments with JSON libraries, it's
drastically more complex for environments (like embedded hardware)
which doesn't support JSON. And writing basic form encoded parsing
code really isn't that hard – especially if I can do it!


On Tue, Apr 20, 2010 at 9:24 AM, Joseph Smarr <jsmarr@gmail.com> wrote:
> +1 to including JSON format, and perhaps making it the required format. In
> my experience helping numerous developers debug their OAuth implementations,
> url-encoding/decoding was often a source of bugs, since a) the libraries are
> usually hand-built, b) url-encoding is known to be funky/inconsistent wrt +
> vs. %20 and other such things, and c) it's very sensitive to things like a
> trailing newline at the end of the response, which can easily be tokenized
> as part of the the last value (since the normal implementations just split
> on & and =). In contrast, I've never heard of any problems parsing JSON, nor
> any encoding/decoding bugs related to working with JSON in other APIs
> (something I *cannot* say about XML, which is way more finicky about
> requiring its values to be properly encoded or escaped in CDATA etc.; I've
> also seen way more inconsistency in support of XML parsers and their output
> formats, whereas JSON always works exactly the same way and always "just
> works").
> So in conclusion, url-encoding has caused a lot of pain in OAuth 1.0, and
> JSON is already widely supported (presumably including by most APIs that
> you're building OAuth support to be able to access!), so I think it would
> simplify the spec and increase ease/success of development to use JSON as a
> request format. In fact, I think I'd like to push for it to be the
> default/required format, given the positive attributes above. Does anyone
> object, and if so, why?
> Thanks, js
>
> On Tue, Apr 20, 2010 at 8:10 AM, Eran Hammer-Lahav <eran@hueniverse.com>
> wrote:
>>
>> There seems to be support for this idea with some concerns about
>> complexity. Someone needs to propose text for this including defining the
>> request parameter and schema of the various reply formats.
>>
>> EHL
>>
>> > -----Original Message-----
>> > From: Torsten Lodderstedt [mailto:torsten@lodderstedt.net]
>> > Sent: Monday, April 19, 2010 4:48 AM
>> > To: Eran Hammer-Lahav
>> > Cc: Dick Hardt; OAuth WG
>> > Subject: Re: [OAUTH-WG] application/x-www-form-urlencoded vs JSON
>> >
>> >
>> > > We can also offer both and define a client request parameter (as long
>> > > as the server is required to make at least one format available).
>> >
>> > +1 on this
>> >
>> > regards,
>> > Torsten.
>> >
>> > >
>> > > EHL
>> > >
>> > >> -----Original Message-----
>> > >> From: oauth-bounces@ietf.org [mailto:oauth-bounces@ietf.org] On
>> > >> Behalf Of Dick Hardt
>> > >> Sent: Sunday, April 18, 2010 9:30 PM
>> > >> To: OAuth WG
>> > >> Subject: [OAUTH-WG] application/x-www-form-urlencoded vs JSON
>> > >>
>> > >> The AS token endpoint response is encoded as application/x-www-form-
>> > >> urlencoded
>> > >>
>> > >> While this reuses a well known and understood encoding standard, it
>> > >> is uncommon for a client to receive a message encoded like this. Most
>> > >> server responses are encoded as XML or JSON. Libraries are NOT
>> > >> reedily available to parse application/x-www-form-urlencoded results
>> > >> as this is something that is typically done in the web servers
>> > >> framework. While parsing the name value pairs and URL un-encoding
>> > >> them is not hard, many developers have been caught just splitting the
>> > parameters and forgetting to URL decode the token.
>> > >> Since the token is opaque and may contain characters that are
>> > >> escaped, it is a difficult bug to detect.
>> > >>
>> > >> Potential options:
>> > >>
>> > >> 1) Do nothing, developers should read the specs and do the right
>> > >> thing.
>> > >>
>> > >> 2) Require that all parameters are URL safe so that there is no
>> > >> encoding issue.
>> > >>
>> > >> 3) Return results as JSON, and recommend that parameters be URL safe.
>> > >>
>> > >> -- Dick
>> > >> _______________________________________________
>> > >> OAuth mailing list
>> > >> OAuth@ietf.org
>> > >> https://www.ietf.org/mailman/listinfo/oauth
>> > > _______________________________________________
>> > > OAuth mailing list
>> > > OAuth@ietf.org
>> > > https://www.ietf.org/mailman/listinfo/oauth
>> > >
>> >
>> >
>> >
>>
>> _______________________________________________
>> OAuth mailing list
>> OAuth@ietf.org
>> https://www.ietf.org/mailman/listinfo/oauth
>
>
> _______________________________________________
> OAuth mailing list
> OAuth@ietf.org
> https://www.ietf.org/mailman/listinfo/oauth
>
>