Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reduce public interface by making some methods private #394

Merged
merged 1 commit into from
Oct 6, 2023
Merged

Reduce public interface by making some methods private #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 12 additions & 25 deletions src/signed-xml.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export class SignedXml {
}
}

getCanonSignedInfoXml(doc: Document) {
private getCanonSignedInfoXml(doc: Document) {
if (this.signatureNode == null) {
throw new Error("No signature found.");
}
Expand Down Expand Up @@ -315,7 +315,7 @@ export class SignedXml {
return this.getCanonXml([this.canonicalizationAlgorithm], signedInfo[0], c14nOptions);
}

getCanonReferenceXml(doc: Document, ref: Reference, node: Node) {
private getCanonReferenceXml(doc: Document, ref: Reference, node: Node) {
/**
* Search for ancestor namespaces before canonicalization.
*/
Expand All @@ -331,20 +331,7 @@ export class SignedXml {
return this.getCanonXml(ref.transforms, node, c14nOptions);
}

/** @deprecated */
validateSignatureValue(doc: Document): boolean;
/** @deprecated */
validateSignatureValue(doc: Document, callback: ErrorFirstCallback<boolean>): void;
/** @deprecated */
validateSignatureValue(doc: Document, callback?: ErrorFirstCallback<boolean>): boolean | void {
if (callback) {
this.checkSignature(doc.toString(), callback);
} else {
return this.checkSignature(doc.toString());
}
}

calculateSignatureValue(doc: Document, callback?: ErrorFirstCallback<string>) {
private calculateSignatureValue(doc: Document, callback?: ErrorFirstCallback<string>) {
const signedInfoCanon = this.getCanonSignedInfoXml(doc);
const signer = this.findSignatureAlgorithm(this.signatureAlgorithm);
if (this.privateKey == null) {
Expand All @@ -357,7 +344,7 @@ export class SignedXml {
}
}

findSignatureAlgorithm(name: SignatureAlgorithmType) {
private findSignatureAlgorithm(name: SignatureAlgorithmType) {
const algo = this.SignatureAlgorithms[name];
if (algo) {
return new algo();
Expand All @@ -366,7 +353,7 @@ export class SignedXml {
}
}

findCanonicalizationAlgorithm(name: CanonicalizationOrTransformAlgorithmType) {
private findCanonicalizationAlgorithm(name: CanonicalizationOrTransformAlgorithmType) {
const algo = this.CanonicalizationAlgorithms[name];
if (algo) {
return new algo();
Expand All @@ -375,7 +362,7 @@ export class SignedXml {
}
}

findHashAlgorithm(name: HashAlgorithmType) {
private findHashAlgorithm(name: HashAlgorithmType) {
const algo = this.HashAlgorithms[name];
if (algo) {
return new algo();
Expand Down Expand Up @@ -415,7 +402,7 @@ export class SignedXml {
throw new Error("No references passed validation");
}

validateReference(ref: Reference, doc: Document) {
private validateReference(ref: Reference, doc: Document) {
const uri = ref.uri?.[0] === "#" ? ref.uri.substring(1) : ref.uri;
let elem: xpath.SelectSingleReturnType;

Expand Down Expand Up @@ -547,7 +534,7 @@ export class SignedXml {
* Load the reference xml node to a model
*
*/
loadReference(refNode: Node) {
private loadReference(refNode: Node) {
let nodes = utils.findChildren(refNode, "DigestMethod");
if (nodes.length === 0) {
throw new Error(`could not find DigestMethod in reference ${refNode.toString()}`);
Expand Down Expand Up @@ -886,7 +873,7 @@ export class SignedXml {
* Generate the Reference nodes (as part of the signature process)
*
*/
createReferences(doc, prefix) {
private createReferences(doc, prefix) {
let res = "";

prefix = prefix || "";
Expand Down Expand Up @@ -971,7 +958,7 @@ export class SignedXml {
* Ensure an element has Id attribute. If not create it with unique value.
* Work with both normal and wssecurity Id flavour
*/
ensureHasId(node) {
private ensureHasId(node) {
let attr;

if (this.idMode === "wssecurity") {
Expand Down Expand Up @@ -1016,7 +1003,7 @@ export class SignedXml {
* Create the SignedInfo element
*
*/
createSignedInfo(doc, prefix) {
private createSignedInfo(doc, prefix) {
const transform = this.findCanonicalizationAlgorithm(this.canonicalizationAlgorithm);
const algo = this.findSignatureAlgorithm(this.signatureAlgorithm);
let currentPrefix;
Expand Down Expand Up @@ -1046,7 +1033,7 @@ export class SignedXml {
* Create the Signature element
*
*/
createSignature(prefix?: string) {
private createSignature(prefix?: string) {
let xmlNsAttr = "xmlns";

if (prefix) {
Expand Down
2 changes: 1 addition & 1 deletion src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export interface ComputeSignatureOptionsLocation {
/**
* Options for the computeSignature method.
*
* - `prefix` {String} Adds a prefix for the generated signature tags
* - `prefix` {String} Adds a prefix for the generated signature tags
* - `attrs` {Object} A hash of attributes and values `attrName: value` to add to the signature root node
* - `location` {{ reference: String, action: String }}
* - `existingPrefixes` {Object} A hash of prefixes and namespaces `prefix: namespace` already in the xml
Expand Down