samlify 2.9.0 → 2.10.0

package/types/src/binding-simplesign.d.ts

@@ -31,7 +31,7 @@ declare function base64LoginRequest(entity: any, customTagReplacement?: (templat
 * @param  {string}  relayState               the relay state
 * @param  {function} customTagReplacement     used when developers have their own login response template
 */
-declare function base64LoginResponse(requestInfo: any, entity: any, user?: any, relayState?: string, customTagReplacement?: (template: string) => BindingContext): Promise<BindingSimpleSignContext>;
+declare function base64LoginResponse(requestInfo: any | undefined, entity: any, user?: any, relayState?: string, customTagReplacement?: (template: string) => BindingContext): Promise<BindingSimpleSignContext>;
 declare const simpleSignBinding: {
     base64LoginRequest: typeof base64LoginRequest;
     base64LoginResponse: typeof base64LoginResponse;

package/types/src/entity.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { IdpMetadata as IdpMetadataConstructor } from './metadata-idp';
 import { SpMetadata as SpMetadataConstructor } from './metadata-sp';
 import { MetadataIdpConstructor, MetadataSpConstructor, EntitySetting } from './types';
@@ -31,7 +30,7 @@ export interface ParseResult {
     extract: any;
     sigAlg: string;
 }
-export declare type EntityConstructor = (MetadataIdpConstructor | MetadataSpConstructor) & {
+export type EntityConstructor = (MetadataIdpConstructor | MetadataSpConstructor) & {
     metadata?: string | Buffer;
 };
 export default class Entity {

package/types/src/extractor.d.ts

@@ -6,7 +6,7 @@ interface ExtractorField {
     attributePath?: string[];
     context?: boolean;
 }
-export declare type ExtractorFields = ExtractorField[];
+export type ExtractorFields = ExtractorField[];
 export declare const loginRequestFields: ExtractorFields;
 export declare const loginResponseStatusFields: {
     key: string;

package/types/src/libsaml.d.ts

@@ -3,7 +3,6 @@
 * @author tngan
 * @desc  A simple library including some common functions
 */
-/// <reference types="node" />
 import { MetadataInterface } from './metadata';
 export interface SignatureConstructor {
     rawSamlMessage: string;
@@ -58,7 +57,7 @@ export interface LogoutRequestTemplate extends BaseSamlTemplate {
 }
 export interface LogoutResponseTemplate extends BaseSamlTemplate {
 }
-export declare type KeyUse = 'signing' | 'encryption';
+export type KeyUse = 'signing' | 'encryption';
 export interface KeyComponent {
     [key: string]: any;
 }
@@ -86,7 +85,7 @@ export interface LibSamlInterface {
     defaultLogoutResponseTemplate: LogoutResponseTemplate;
 }
 declare const _default: {
-    createXPath: (local: any, isExtractAll?: boolean | undefined) => string;
+    createXPath: (local: any, isExtractAll?: boolean) => string;
     getQueryParamByType: (type: string) => "SAMLRequest" | "SAMLResponse";
     defaultLoginRequestTemplate: {
         context: string;
@@ -121,7 +120,7 @@ declare const _default: {
     * @param  {array} tagValues    tag values
     * @return {string}
     */
-    replaceTagsByValue(rawXML: string, tagValues: any): string;
+    replaceTagsByValue(rawXML: string, tagValues: Record<string, unknown>): string;
     /**
     * @desc Helper function to build the AttributeStatement tag
     * @param  {LoginResponseAttribute} attributes    an array of attribute configuration
@@ -146,9 +145,11 @@ declare const _default: {
     * @desc Verify the XML signature
     * @param  {string} xml xml
     * @param  {SignatureVerifierOptions} opts cert declares the X509 certificate
-    * @return {boolean} verification result
-    */
-    verifySignature(xml: string, opts: SignatureVerifierOptions): (string | boolean | null)[];
+     * @return {[boolean, string | null]} - A tuple where:
+     *   - The first element is `true` if the signature is valid, `false` otherwise.
+     *   - The second element is the cryptographically authenticated assertion node as a string, or `null` if not found.
+     */
+    verifySignature(xml: string, opts: SignatureVerifierOptions): (string | boolean)[] | (boolean | null)[];
     /**
     * @desc Helper function to create the key section in metadata (abstraction for signing and encrypt use)
     * @param  {string} use          type of certificate (e.g. signing, encrypt)
@@ -164,7 +165,7 @@ declare const _default: {
     * @param  {string} signingAlgorithm          signing algorithm
     * @return {string} message signature
     */
-    constructMessageSignature(octetString: string, key: string, passphrase?: string | undefined, isBase64?: boolean | undefined, signingAlgorithm?: string | undefined): string | Buffer;
+    constructMessageSignature(octetString: string, key: string, passphrase?: string, isBase64?: boolean, signingAlgorithm?: string): string | Buffer;
     /**
     * @desc Verifies message signature
     * @param  {Metadata} metadata                 metadata object of identity provider or service provider
@@ -173,13 +174,16 @@ declare const _default: {
     * @param  {string} verifyAlgorithm            algorithm used to verify
     * @return {boolean} verification result
     */
-    verifyMessageSignature(metadata: any, octetString: string, signature: string | Buffer, verifyAlgorithm?: string | undefined): boolean;
+    verifyMessageSignature(metadata: any, octetString: string, signature: string | Buffer, verifyAlgorithm?: string): boolean;
     /**
     * @desc Get the public key in string format
     * @param  {string} x509Certificate certificate
     * @return {string} public key
     */
-    getKeyInfo(x509Certificate: string, signatureConfig?: any): void;
+    getKeyInfo(x509Certificate: string, signatureConfig?: any): {
+        getKeyInfo: () => string;
+        getKey: () => string;
+    };
     /**
     * @desc Encrypt the assertion section in Response
     * @param  {Entity} sourceEntity             source entity
@@ -187,7 +191,7 @@ declare const _default: {
     * @param  {string} xml                      response in xml string format
     * @return {Promise} a promise to resolve the finalized xml
     */
-    encryptAssertion(sourceEntity: any, targetEntity: any, xml?: string | undefined): Promise<string>;
+    encryptAssertion(sourceEntity: any, targetEntity: any, xml?: string): Promise<string>;
     /**
     * @desc Decrypt the assertion section in Response
     * @param  {string} type             only accept SAMLResponse to proceed decryption

package/types/src/metadata.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface MetadataInterface {
     xmlString: string;
     getMetadata: () => string;

package/types/src/types.d.ts

@@ -1,11 +1,10 @@
-/// <reference types="node" />
 import { LoginResponseTemplate } from './libsaml';
 export { IdentityProvider as IdentityProviderConstructor } from './entity-idp';
 export { IdpMetadata as IdentityProviderMetadata } from './metadata-idp';
 export { ServiceProvider as ServiceProviderConstructor } from './entity-sp';
 export { SpMetadata as ServiceProviderMetadata } from './metadata-sp';
-export declare type MetadataFile = string | Buffer;
-declare type SSOService = {
+export type MetadataFile = string | Buffer;
+type SSOService = {
     isDefault?: boolean;
     Binding: string;
     Location: string;
@@ -20,7 +19,7 @@ export interface MetadataIdpOptions {
     singleLogoutService?: SSOService[];
     requestSignatureAlgorithm?: string;
 }
-export declare type MetadataIdpConstructor = MetadataIdpOptions | MetadataFile;
+export type MetadataIdpConstructor = MetadataIdpOptions | MetadataFile;
 export interface MetadataSpOptions {
     entityID?: string;
     signingCert?: string | Buffer | (string | Buffer)[];
@@ -37,8 +36,8 @@ export interface MetadataSpOptions {
     assertionConsumerService?: SSOService[];
     elementsOrder?: string[];
 }
-export declare type MetadataSpConstructor = MetadataSpOptions | MetadataFile;
-export declare type EntitySetting = ServiceProviderSettings & IdentityProviderSettings;
+export type MetadataSpConstructor = MetadataSpOptions | MetadataFile;
+export type EntitySetting = ServiceProviderSettings & IdentityProviderSettings;
 export interface SignatureConfig {
     prefix?: string;
     location?: {
@@ -49,7 +48,7 @@ export interface SignatureConfig {
 export interface SAMLDocumentTemplate {
     context?: string;
 }
-export declare type ServiceProviderSettings = {
+export type ServiceProviderSettings = {
     metadata?: string | Buffer;
     entityID?: string;
     authnRequestsSigned?: boolean;
@@ -76,7 +75,7 @@ export declare type ServiceProviderSettings = {
     relayState?: string;
     clockDrifts?: [number, number];
 };
-export declare type IdentityProviderSettings = {
+export type IdentityProviderSettings = {
     metadata?: string | Buffer;
     /** signature algorithm */
     requestSignatureAlgorithm?: string;

package/types/src/utility.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /**
  * @desc Mimic lodash.zipObject
  * @param arr1 {string[]}
@@ -35,7 +34,7 @@ export declare function get(obj: any, path: any, defaultValue: any): any;
  * @desc Check if the input is string
  * @param {any} input
  */
-export declare function isString(input: any): boolean;
+export declare function isString(input: any): input is string;
 /**
 * @desc Encode string with base64 format
 * @param  {string} message                       plain-text message

package/types/src/validator.d.ts

@@ -1,3 +1,3 @@
-declare type DriftTolerance = [number, number];
+type DriftTolerance = [number, number];
 declare function verifyTime(utcNotBefore: string | undefined, utcNotOnOrAfter: string | undefined, drift?: DriftTolerance): boolean;
 export { verifyTime };