man(8)

πŸ’– man(8) β€” mellon_create_metadata, bestie edition πŸ’–

okay so you're in section 8 of the manual, and we're talking about mellon_create_metadata from the mellon_create_metadata manual page. pull up a chair, grab a strawberry πŸ“, we're setting up some SAML and it's gonna be adorable.


✨ NAME ✨

mellon_create_metadata β€” the lil glow-up tool that populates your initial SP metadata for mod_auth_mellon πŸ¦‹


🌸 SYNOPSIS 🌸

mellon_create_metadata ENTITY-ID ENDPOINT-URL

that's it. two arguments. two!! you got this, no cap.


πŸ‘‘ DESCRIPTION πŸ‘‘

so the Apache module mod_auth_mellon is out here providing a SAML 2.0 service provider (SP) β€” that's the whole vibe. but here's the thing, bestie: a service provider needs metadata to function. it simply cannot slay without it. 😭

and that's literally where mellon_create_metadata comes in β€” it creates the initial configuration for you. ✨

when you run it, three files show up in the current directory:

  1. a public key πŸ”‘
  2. a private key πŸ” (keep this one safe fr fr)
  3. a boilerplate metadata xml file πŸ“„ β€” and this one already has the public key and the URLs of this installation baked in, and you can edit it further at will, whenever, however, it's yours

the way you reference these in your config options, in order:

  • MellonSPPrivateKeyFile β€” the private key file πŸ’œ
  • MellonSPCertFile β€” the cert file πŸŽ€
  • MellonSPMetadataFile β€” the metadata file 🌈

respectively. yes, in that order. iykyk. πŸ’…


πŸ’… OPTIONS πŸ’…

okay so technically these are the two positional arguments, and they are not optional, so let's give them the main character energy they deserve:

  • ENTITY-ID β€” this is the entity ID you want for your SP, and listen: it needs to be globally unique. globally!! so it's an URL or a URN, probably with your own domain in it. no duplicates, that's the rule. πŸ‘‘
  • ENDPOINT-URL β€” the full URL to your mellon installation. it normally ends with "/mellon" unless you've configured it otherwise. that's it, that's the note. πŸ¦‹

⭐ EXAMPLE ⭐

here's a whole moment, an actual example, look at her go:

mellon_create_metadata urn:someservice https://sp.example.org/mellon

ate. no notes. πŸ”₯


🫢 AUTHOR 🫢

this iconic human made it: Thijs Kinkhorst <thijs.kinkhorst@surfnet.nl>


and that's the whole page, bestie β€” version 1.0, dated 25 January 2020, living its life as part of the mellon_create_metadata manual page in section 8 of the manual. go forth and make some metadata, you absolute legend. πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…πŸ«Ά

πŸ“¦ where this page comes from