cabreran/xmlseclibs

A PHP library for XML Security

v3.1.0 2020-07-17 19:46 UTC

Requires

• php: >= 7.1
• ext-openssl: *

BSD-3-Clause

• xml
• security
• signature
• xmldsig

README

#xmlseclibs

xmlseclibs is a library written in PHP for working with XML Encryption and Signatures.

Requirements

xmlseclibs requires PHP version 7.1 or greater.

How to Install

Install with composer.phar.

php composer.phar require "cabreran/xmlseclibs"

Use cases

xmlseclibs is being used in many different software.

• SimpleSAMLPHP
• LightSAML
• OneLogin

Basic usage

The example below shows basic usage of xmlseclibs, with a SHA-256 signature.

use Cabreran\XMLSecLibs\XMLSecurityDSig;
use Cabreran\XMLSecLibs\XMLSecurityKey;

// Load the XML to be signed
$doc = new DOMDocument();
$doc->load('./path/to/file/tobesigned.xml');

// Create a new Security object 
$objDSig = new XMLSecurityDSig();
// Use the c14n exclusive canonicalization
$objDSig->setCanonicalMethod(XMLSecurityDSig::EXC_C14N);
// Sign using SHA-256
$objDSig->addReference(
    $doc, 
    XMLSecurityDSig::SHA256, 
    array('http://www.w3.org/2000/09/xmldsig#enveloped-signature')
);

// Create a new (private) Security key
$objKey = new XMLSecurityKey(XMLSecurityKey::RSA_SHA256, array('type'=>'private'));
/*
If key has a passphrase, set it using
$objKey->passphrase = '<passphrase>';
*/
// Load the private key
$objKey->loadKey('./path/to/privatekey.pem', TRUE);

// Sign the XML file
$objDSig->sign($objKey);

// Add the associated public key to the signature
$objDSig->add509Cert(file_get_contents('./path/to/file/mycert.pem'));

// Append the signature to the XML
$objDSig->appendSignature($doc->documentElement);
// Save the signed XML
$doc->save('./path/to/signed.xml');