Documentation
¶
Index ¶
- Variables
- func Verify(f *os.File, opts options.VerifyOptions) error
- type CanonicalizationAlgorithm
- type EnvelopedSignature
- type ExclusiveCanonicalization
- type Signature
- type Signer
- type Validator
- func (v *Validator) SetReferenceIDAttribute(refIDAttribute string)
- func (s *Validator) SetSignature(sig string) error
- func (v *Validator) SetXML(xml string) error
- func (v *Validator) SigningCert() x509.Certificate
- func (v *Validator) Validate() errordeprecated
- func (v *Validator) ValidateReferences() ([]string, error)
Constants ¶
This section is empty.
Variables ¶
var CanonicalizationAlgorithms map[string]CanonicalizationAlgorithm
CanonicalizationAlgorithms maps the CanonicalizationMethod or Transform Algorithm URIs to a type that implements the CanonicalizationAlgorithm interface.
Implementations are provided for the following transforms:
http://www.w3.org/2001/10/xml-exc-c14n# (ExclusiveCanonicalization) http://www.w3.org/2001/10/xml-exc-c14n#WithComments (ExclusiveCanonicalizationWithComments) http://www.w3.org/2000/09/xmldsig#enveloped-signature (EnvelopedSignature)
Custom implementations can be added to the map
Functions ¶
Types ¶
type CanonicalizationAlgorithm ¶
type CanonicalizationAlgorithm interface {
Process(inputXML string, transformXML string) (outputXML string, err error)
}
CanonicalizationAlgorithm defines an interface for processing an XML document into a standard format.
If any child elements are in the Transform node, the entire transform node will be passed to the Process method through the transformXML parameter as an XML string. This is necessary for transforms that need additional processing data, like XPath (http://www.w3.org/TR/xmldsig-core/#sec-XPath). If there are no child elements in Transform (or CanonicalizationMethod), then an empty string will be passed through.
type EnvelopedSignature ¶
type EnvelopedSignature struct{}
EnvelopedSignature implements the CanonicalizationAlgorithm interface and is used for processing the http://www.w3.org/2000/09/xmldsig#enveloped-signature transform algorithm
type ExclusiveCanonicalization ¶
type ExclusiveCanonicalization struct {
WithComments bool
// contains filtered or unexported fields
}
ExclusiveCanonicalization implements the CanonicalizationAlgorithm interface and is used for processing the http://www.w3.org/2001/10/xml-exc-c14n# and http://www.w3.org/2001/10/xml-exc-c14n#WithComments transform algorithms
type Signature ¶
type Signature struct {
PublicKey crypto.PublicKey
Certificates []*x509.Certificate
Hash crypto.Hash
EncryptedDigest []byte
Reference *etree.Element
}
func (Signature) Leaf ¶
func (s Signature) Leaf() *x509.Certificate
type Signer ¶
type Signer struct {
// contains filtered or unexported fields
}
Signer provides options for signing an XML document
func (*Signer) SetReferenceIDAttribute ¶
SetReferenceIDAttribute set the referenceIDAttribute
func (*Signer) SetSignature ¶
SetSignature can be used to assign an external signature for the XML doc that Validator will verify
type Validator ¶
type Validator struct {
Certificates []*x509.Certificate
// contains filtered or unexported fields
}
Validator provides options for verifying a signed XML document
func NewValidator ¶
func NewValidator(xml string, opts signers.VerifyOpts) (*Validator, error)
NewValidator returns a *Validator for the XML provided
func (*Validator) SetReferenceIDAttribute ¶
SetReferenceIDAttribute set the referenceIDAttribute
func (*Validator) SetSignature ¶
SetSignature can be used to assign an external signature for the XML doc that Validator will verify
func (*Validator) SigningCert ¶
func (v *Validator) SigningCert() x509.Certificate
SigningCert returns the certificate, if any, that was used to successfully validate the signature of the XML document. This will be a zero value x509.Certificate before Validator.Validate is successfully called.
func (*Validator) ValidateReferences ¶
ValidateReferences validates the Reference digest values, and the signature value over the SignedInfo.
If the signature is enveloped in the XML, then it will be used. Otherwise, an external signature should be assigned using Validator.SetSignature.
The references returned by this method can be used to verify what was signed.
Source Files