OAuth:...gorithm(3pm)

✨ NAME ✨

OAuth::Lite2::Signer::Algorithm — it's the signature algorithm base class, bestie. And yes, this page lives in section 3pm of the manual (the header says OAuth:...gorithm(3pm) because the title got squished, iykyk). 💅

---

🌸 SYNOPSIS 🌸

Okay so here's the vibe: you don't use this class directly, you make a child class that inherits from it. Like this:

package OAuth::Lite2::Signer::Algorithm::Foo;
use parent 'OAuth::Lite2::Signer::Algorithm';
sub hash {
    # override
}
1;

And then you use it through the hash method interface, like:

my $algorithm = OAuth::Lite2::Signer::Algorithm::Foo->new;
my $signature = $algorithm->hash($key, $text);

That's it. That's the whole flow. 🦋

---

🎀 DESCRIPTION 🎀

DEPRECATED. Not me having to tell you this — it's literally the signature algorithm base class, but it's deprecated. So like, keep that in mind, okay? 👑

---

💖 METHODS 💖

• new( ) — the constructor. Makes you a fresh object, main character energy. ✨
• name — hands you back a name of the algorithm. Simple as that. 🫶
• hash( $key, $text ) — this one generates the signature for you, no cap:

my $signature = $algorithm->hash($key, $text);

---

🌈 SEE ALSO 🌈

• OAuth::Lite2::Signer::Algorithms
• OAuth::Lite2::Signer::Algorithm::HMAC_SHA1
• OAuth::Lite2::Signer::Algorithm::HMAC_SHA256

Go read those too, they're the supporting cast and they ate. 💜

---

👑 AUTHOR 👑

Lyo Kato, <lyo.kato@gmail.com>

---

🍓 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 a wrap, bestie! 🧚 This lil' page was generated by perl v5.36.0 on 2023-07-01, and the manual name up top is OAuth:...gorithm(3pm). Slay, go sign some stuff. 💖✨