Web::I...nerator(3pm)

✨ NAME ✨

Web::ID::Certificate::Generator — it's a role for Web::ID::Certificate 💖

---

🎀 SYNOPSIS 🎀

use Web::ID::Certificate::Generator;

my %options = (
  cert_output       => '/home/alice/webid.p12',
  passphrase        => 's3cr3t s0urc3',
  rdf_output        => '/home/alice/public_html/foaf.rdf',
  subject_alt_names => [
    Web::ID::SAN::URI->new(
      value => 'http://example.com/~alice/foaf.rdf#me',
    ),
    Web::ID::SAN::Email->new(
      value => 'alice@example.com',
    ),
  ],
  subject_name      => 'Alice Jones',
  subject_locality  => 'Lewes',
  subject_region    => 'East Sussex',
  subject_country   => 'GB',   # ISO 3166-1 alpha-2 code
);

my $cert = Web::ID::Certificate->generate(%options);

---

🌸 DESCRIPTION 🌸

Okay bestie, so Web::ID::Certificate::Generator is a role that you can apply to Web::ID::Certificate. And like… it is not consumed by Web::ID::Certificate by default, because the author was literally trying to avoid tainting the class with the horror that's found in this role 💀 (their words, not mine, and honestly? valid).

The good news: the import routine of this package applies the role to Web::ID::Certificate for you, so this is genuinely all you need:

use Web::ID::Certificate::Generator;

You do not need to muck around with apply_all_roles yourself. Not even a little. 🫶

💅 Constructor

• generate(%options) — Generates a brand new WebID-enabled certificate. That's it, that's the whole vibe. ✨

🌈 Options

These are the options you can pass to generator 👑

• cert_output — A passphrase-protected PKCS12 certificate file gets generated as part of the certificate generation process. The PKCS12 file is the thing you'd typically import into a browser 🌐.

You can pass a scalar reference, and in that case the PKCS12 data gets written to that scalar; or you can pass a file handle or a string file name.

This is a required option. No skipping, bestie.

• passphrase — The password for the PKCS12 file 🔐.

This is a required option.

• rdf_output — RDF data is also generated as part of the certificate generation process 🦋.

Again, a file handle or string file name can be passed, or an RDF::Trine::Model.

This is a required option.

• subject_alt_names — A list of Web::ID::SAN objects, used to generate the certificate's subjectAltNames field. You want at least one Web::ID::SAN::URI in there, fr fr.

This is a required option.

• subject_name — The name of the person who will hold the certificate. (e.g. "Alice Smith".) 👑

This is a required option.

• subject_org — The certificate holder's organisation.

Not required 💜

• subject_locality — The locality (e.g. city) of the certificate holder's address.

Not required 💜

• subject_region — The region (e.g. state or county) of the certificate holder's address.

Not required 💜

• subject_country — Two letter ISO code for the country of the certificate holder's address.

Not required 💜

• openssl_path — The path to the OpenSSL binary. And yes, that's right — this role calls the OpenSSL binary via system calls 😭 it's giving shelling out. Defaults to automatic discovery via Web::ID::Util::FindOpenSSL.
• key_size — Key size in bits. Defaults to 1024. Bigger keys are more secure 🔥. Keys bigger than 2048 bits will take a ridiculously long time to generate. Keys less than 512 bits are pretty poor 🙈.
• not_after — Date when the certificate should expire, as a DateTime object. Defaults to 365 days.

---

💀 BUGS AND LIMITATIONS 💀

Generating the private key results in shedloads of nasty crud being spewed out on STDERR. Yeah. Not cute. 😭

Please report any bugs to <http://rt.cpan.org/Dist/Display.html?Queue=Web-ID>.

---

🦋 SEE ALSO 🦋

Web::ID, Web::ID::Certificate.

---

🌟 AUTHOR 🌟

Toby Inkster <tobyink@cpan.org>.

---

🎀 COPYRIGHT AND LICENCE 🎀

This software is copyright (c) 2012 by Toby Inkster.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Slay 💅

---

👑 DISCLAIMER OF WARRANTIES 👑

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Like, no promises. None. Zero. Nada. 🫶

---

Okay that's the whole page bestie, go generate some certificates 💖 This was Web::I...nerator(3pm) from perl v5.32.1, dated 2021-09-11 ✨ mwah 😘