@wildboar/pki-stub
Version:
X.510 PKI-Stub ASN.1 data structures in TypeScript
205 lines (204 loc) • 6.89 kB
TypeScript
import { ASN1Element as _Element, OPTIONAL } from "asn1-ts";
import * as $ from "asn1-ts/dist/node/functional";
import { AdministrationDomainName } from "../PkiPmiExternalDataTypes/AdministrationDomainName.ta";
import { CountryName } from "../PkiPmiExternalDataTypes/CountryName.ta";
import { NetworkAddress } from "../PkiPmiExternalDataTypes/NetworkAddress.ta";
import { NumericUserIdentifier } from "../PkiPmiExternalDataTypes/NumericUserIdentifier.ta";
import { OrganizationalUnitNames } from "../PkiPmiExternalDataTypes/OrganizationalUnitNames.ta";
import { OrganizationName } from "../PkiPmiExternalDataTypes/OrganizationName.ta";
import { PersonalName } from "../PkiPmiExternalDataTypes/PersonalName.ta";
import { PrivateDomainName } from "../PkiPmiExternalDataTypes/PrivateDomainName.ta";
import { TerminalIdentifier } from "../PkiPmiExternalDataTypes/TerminalIdentifier.ta";
/**
* @summary BuiltInStandardAttributes
* @description
*
* ### ASN.1 Definition:
*
* ```asn1
* BuiltInStandardAttributes ::= SEQUENCE {
* country-name CountryName OPTIONAL,
* administration-domain-name AdministrationDomainName OPTIONAL,
* network-address [0] NetworkAddress OPTIONAL,
* -- see also extended-network-address
* terminal-identifier [1] TerminalIdentifier OPTIONAL,
* private-domain-name [2] PrivateDomainName OPTIONAL,
* organization-name [3] OrganizationName OPTIONAL,
* -- see also teletex-organization-name
* numeric-user-identifier [4] NumericUserIdentifier OPTIONAL,
* personal-name [5] PersonalName OPTIONAL,
* -- see also teletex-personal-name
* organizational-unit-names [6] OrganizationalUnitNames OPTIONAL
* -- see also teletex-organizational-unit-names --}
* ```
*
* @class
*/
export declare class BuiltInStandardAttributes {
/**
* @summary `country_name`.
* @public
* @readonly
*/
readonly country_name?: OPTIONAL<CountryName>;
/**
* @summary `administration_domain_name`.
* @public
* @readonly
*/
readonly administration_domain_name?: OPTIONAL<AdministrationDomainName>;
/**
* @summary `network_address`.
* @public
* @readonly
*/
readonly network_address?: OPTIONAL<NetworkAddress>;
/**
* @summary `terminal_identifier`.
* @public
* @readonly
*/
readonly terminal_identifier?: OPTIONAL<TerminalIdentifier>;
/**
* @summary `private_domain_name`.
* @public
* @readonly
*/
readonly private_domain_name?: OPTIONAL<PrivateDomainName>;
/**
* @summary `organization_name`.
* @public
* @readonly
*/
readonly organization_name?: OPTIONAL<OrganizationName>;
/**
* @summary `numeric_user_identifier`.
* @public
* @readonly
*/
readonly numeric_user_identifier?: OPTIONAL<NumericUserIdentifier>;
/**
* @summary `personal_name`.
* @public
* @readonly
*/
readonly personal_name?: OPTIONAL<PersonalName>;
/**
* @summary `organizational_unit_names`.
* @public
* @readonly
*/
readonly organizational_unit_names?: OPTIONAL<OrganizationalUnitNames>;
constructor(
/**
* @summary `country_name`.
* @public
* @readonly
*/
country_name?: OPTIONAL<CountryName>,
/**
* @summary `administration_domain_name`.
* @public
* @readonly
*/
administration_domain_name?: OPTIONAL<AdministrationDomainName>,
/**
* @summary `network_address`.
* @public
* @readonly
*/
network_address?: OPTIONAL<NetworkAddress>,
/**
* @summary `terminal_identifier`.
* @public
* @readonly
*/
terminal_identifier?: OPTIONAL<TerminalIdentifier>,
/**
* @summary `private_domain_name`.
* @public
* @readonly
*/
private_domain_name?: OPTIONAL<PrivateDomainName>,
/**
* @summary `organization_name`.
* @public
* @readonly
*/
organization_name?: OPTIONAL<OrganizationName>,
/**
* @summary `numeric_user_identifier`.
* @public
* @readonly
*/
numeric_user_identifier?: OPTIONAL<NumericUserIdentifier>,
/**
* @summary `personal_name`.
* @public
* @readonly
*/
personal_name?: OPTIONAL<PersonalName>,
/**
* @summary `organizational_unit_names`.
* @public
* @readonly
*/
organizational_unit_names?: OPTIONAL<OrganizationalUnitNames>);
/**
* @summary Restructures an object into a BuiltInStandardAttributes
* @description
*
* This takes an `object` and converts it to a `BuiltInStandardAttributes`.
*
* @public
* @static
* @method
* @param {Object} _o An object having all of the keys and values of a `BuiltInStandardAttributes`.
* @returns {BuiltInStandardAttributes}
*/
static _from_object(_o: Partial<{
[_K in keyof BuiltInStandardAttributes]: BuiltInStandardAttributes[_K];
}>): BuiltInStandardAttributes;
}
/**
* @summary The Leading Root Component Types of BuiltInStandardAttributes
* @description
*
* This is an array of `ComponentSpec`s that define how to decode the leading root component type list of a SET or SEQUENCE.
*
* @constant
*/
export declare const _root_component_type_list_1_spec_for_BuiltInStandardAttributes: $.ComponentSpec[];
/**
* @summary The Trailing Root Component Types of BuiltInStandardAttributes
* @description
*
* This is an array of `ComponentSpec`s that define how to decode the trailing root component type list of a SET or SEQUENCE.
*
* @constant
*/
export declare const _root_component_type_list_2_spec_for_BuiltInStandardAttributes: $.ComponentSpec[];
/**
* @summary The Extension Addition Component Types of BuiltInStandardAttributes
* @description
*
* This is an array of `ComponentSpec`s that define how to decode the extension addition component type list of a SET or SEQUENCE.
*
* @constant
*/
export declare const _extension_additions_list_spec_for_BuiltInStandardAttributes: $.ComponentSpec[];
/**
* @summary Decodes an ASN.1 element into a(n) BuiltInStandardAttributes
* @function
* @param {_Element} el The element being decoded.
* @returns {BuiltInStandardAttributes} The decoded data structure.
*/
export declare function _decode_BuiltInStandardAttributes(el: _Element): BuiltInStandardAttributes;
/**
* @summary Encodes a(n) BuiltInStandardAttributes into an ASN.1 Element.
* @function
* @param {value} el The element being decoded.
* @param elGetter A function that can be used to get new ASN.1 elements.
* @returns {_Element} The BuiltInStandardAttributes, encoded as an ASN.1 Element.
*/
export declare function _encode_BuiltInStandardAttributes(value: BuiltInStandardAttributes, elGetter: $.ASN1Encoder<BuiltInStandardAttributes>): _Element;