OAuth:...Signer(3pm)

✨ OAuth::Lite2::Signer ✨

okay bestie, welcome to OAuth::Lite2::Signer — that's a 3pm manual page from your friendly neighborhood User Contributed Perl Documentation, and yes we are getting into OAuth 2.0 signature territory 💅

🚨 DEPRECATED ALERT 🚨 this whole thing is for the old version of the OAuth 2.0 draft specification. It's giving vintage. It's giving archived. Just so you know before you build your whole personality around it, okay?

---

🦋 SYNOPSIS 🦋

my $signed_params = OAuth::Lite2::Signer->sign(
    secret    => q{my_token_secret},
    algorithm => q{hmac-sha256},
    method    => q{GET},
    url       => q{http://example.org/protected/resource},
);

---

🌸 DESCRIPTION 🌸

DEPRECATED. This is for the old version of the OAuth 2.0 draft specification. Ancient. Historical. A little artifact. 🏺

What does it do, though? Two things, and honestly it ate:

• it lets a client generate a signed request 🔏
• it lets a server verify a request that came in 📬

So it's the whole glow-up pipeline: sign it, send it, check it. Periodt.

---

👑 METHODS 👑

💖 sign( %params )

Returns a hash reference that includes the parameters for an OAuth 2.0 signed request. So cute, so structured.

my $signed_params = OAuth::Lite2::Signer->sign(
    secret    => q{my_token_secret},
    algorithm => q{hmac-sha256},
    method    => q{GET},
    url       => q{http://example.org/protected/resource},
);

Here's the deets on every param, no gatekeeping:

• secret — the access token secret. 🤫
• algorithm — the algorithm you're making the signature with. That's the vibe of your hash, essentially.
• method — the HTTP method of the request.
• url — the URL of the request.
• debug_nonce — optional, bestie. If you omit this, the nonce string gets automatically generated as a random string. 🎲
• debug_timestamp — also optional. If you omit this, the current timestamp is set. ⏰

🧚 normalize_string( %params )

Returns a normalized string according to the specification. It's the tidy-up step, the getting-ready step, the part where everything lines up perfectly. ✨

• host — the host part of the url.
• port — if you omit this, 80 is set by default. 🚪
• nonce — random string.
• timestamp — unix timestamp.
• algorithm — name of hmac hash algorithm.
• method — HTTP method of the request.
• url — URL of the request.

🔥 verify( %params )

Verifies a signed request. The vibe check, but for signatures. 😌

unless ( OAuth::Lite2::Signer->verify( %params ) ) {
    $app->error("Invalid request");
}

• signature — the 'signature' parameter of the received request.
• secret — the access token secret.
• algorithm — the 'algorithm' parameter of the received request.
• method — the HTTP method of the received request.
• url — the URL of the received request.
• nonce — the 'nonce' parameter of the received request.
• timestamp — the 'timestamp' parameter of the received request.

---

🫶 AUTHOR 🫶

Lyo Kato, <lyo.kato@gmail.com> — shoutout, icon behavior, we love a credited author 💜

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright (C) 2010 by Lyo Kato

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

---

and that's the whole page, bestie 💖 this one was written by perl v5.36.0, dated 2023-07-01 — and ngl, the original title was OAuth:...Signer(3pm) and yeah, we're still in the User Contributed Perl Documentation section. go sign something and slay ✨👑