@realsee/five 6.8.0-alpha.2 → 6.8.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS_READ_ME.md +4 -0
- package/AI_CONTEXT.md +4 -0
- package/README.md +9 -6
- package/{guides → ai_guides}/README.md +12 -2
- package/ai_guides/ai-doc-guidelines.md +102 -0
- package/{guides → ai_guides}/api.md +24 -1
- package/ai_guides/features/3dtile.md +172 -0
- package/{guides → ai_guides}/features/camera-animation.md +24 -3
- package/{guides → ai_guides}/features/clipper.md +2 -0
- package/{guides/features/coordnate-system.md → ai_guides/features/coordinate-system.md} +2 -0
- package/{guides → ai_guides}/features/event.md +2 -0
- package/{guides → ai_guides}/features/five.md +4 -0
- package/ai_guides/features/flowing-light-2d-pass.md +438 -0
- package/ai_guides/features/flowing-light-3d-pass.md +420 -0
- package/ai_guides/features/gaussian-blur-pass.md +202 -0
- package/{guides → ai_guides}/features/gesture.md +3 -0
- package/{guides → ai_guides}/features/get-screen-pixels.md +2 -0
- package/{guides → ai_guides}/features/image-options.md +3 -0
- package/{guides → ai_guides}/features/load-external-model.md +21 -0
- package/ai_guides/features/load-progress.md +140 -0
- package/ai_guides/features/material.md +153 -0
- package/{guides → ai_guides}/features/mode.md +4 -0
- package/{guides → ai_guides}/features/model.md +4 -1
- package/{guides → ai_guides}/features/move-pano-effect.md +2 -0
- package/{guides → ai_guides}/features/multi-work.md +2 -0
- package/ai_guides/features/pano-filter.md +148 -0
- package/{guides → ai_guides}/features/pano-tile.md +7 -14
- package/ai_guides/features/pano-uv.md +131 -0
- package/ai_guides/features/parameter.md +153 -0
- package/ai_guides/features/plugin.md +210 -0
- package/{guides → ai_guides}/features/postprocessing.md +39 -4
- package/{guides → ai_guides}/features/raycast.md +11 -0
- package/{guides → ai_guides}/features/request-proxy.md +2 -0
- package/{guides → ai_guides}/features/screen-project.md +2 -0
- package/{guides → ai_guides}/features/state.md +2 -0
- package/ai_guides/features/view-layer.md +187 -0
- package/{guides → ai_guides}/features/work.md +63 -2
- package/{guides → ai_guides}/glossary.md +26 -5
- package/{guides → ai_guides}/intro.md +1 -1
- package/{guides → ai_guides}/quick-start.md +1 -0
- package/ai_guides/release_notes/6.8.md +208 -0
- package/{guides → ai_guides}/template.md +17 -3
- package/docs/00_FOR_AI_AGENTS.md +11 -0
- package/docs/README.md +4 -7
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/five.AdaptiveLuminancePass.html +7 -6
- package/docs/classes/five.BoundingMesh.html +2 -2
- package/docs/classes/five.Camera.html +1 -1
- package/docs/classes/five.EyeDomeLightingPass.html +1 -1
- package/docs/classes/five.Five.html +73 -72
- package/docs/classes/five.FivePass.html +1 -1
- package/docs/classes/five.Histogram.html +19 -0
- package/docs/classes/five.InternalWebGLRenderer.html +1 -1
- package/docs/classes/five.Model.html +31 -31
- package/docs/classes/five.ModelScene.html +1 -1
- package/docs/classes/five.NetworkSubscribe.html +1 -1
- package/docs/classes/five.PBMContainer.html +1 -1
- package/docs/classes/five.PBMCustomShader.html +42 -3
- package/docs/classes/five.PBMGSObject.html +5 -3
- package/docs/classes/five.PBMGroup.html +1 -1
- package/docs/classes/five.PBMMesh.html +1 -1
- package/docs/classes/five.PBMMeshMaterial.html +16 -7
- package/docs/classes/five.PBMPanoFilter.html +61 -0
- package/docs/classes/five.PBMPointCloud.html +1 -1
- package/docs/classes/five.PBMPointCloudMaterial.html +5 -6
- package/docs/classes/five.PBMSkinnedMesh.html +1 -1
- package/docs/classes/five.PBMUpdateable.html +41 -0
- package/docs/classes/five.PanoCircleMesh.html +1 -1
- package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
- package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
- package/docs/classes/five.Parameter.html +57 -53
- package/docs/classes/five.Scene.html +1 -1
- package/docs/classes/five.Subscribe.html +1 -1
- package/docs/classes/five.Tile.html +1 -1
- package/docs/classes/five.Tile3D.html +30 -26
- package/docs/classes/five.TileNode.html +1 -1
- package/docs/classes/five.Trajectory.html +1 -1
- package/docs/classes/five.TrajectoryNode.html +1 -1
- package/docs/classes/five.Work.html +16 -16
- package/docs/classes/five.WorkResolvedObserver.html +27 -2
- package/docs/classes/gltf-loader.DDSLoader.html +1 -1
- package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
- package/docs/classes/gltf-loader.GLTFLoader.html +1 -1
- package/docs/classes/gltf-loader.GLTFObject.html +1 -1
- package/docs/classes/gltf-loader.GLTFParser.html +1 -1
- package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
- package/docs/classes/line.Line.html +1 -1
- package/docs/classes/line.LineGeometry.html +1 -1
- package/docs/classes/line.LineMaterial.html +1 -1
- package/docs/classes/line.LineSegmentsGeometry.html +1 -1
- package/docs/classes/line.THREE_Line2.html +1 -1
- package/docs/classes/line.THREE_LineSegments2.html +1 -1
- package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
- package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
- package/docs/classes/sticker.Sticker.html +1 -1
- package/docs/classes/vfx.Airflow.html +1 -1
- package/docs/classes/vfx.Flame.html +1 -1
- package/docs/classes/vfx.Particle.html +1 -1
- package/docs/classes/vfx.ParticleGPU.html +1 -1
- package/docs/classes/vfx.SpotLight.html +1 -1
- package/docs/documents/README.html +11 -2
- package/docs/documents/ai-doc-guidelines.html +60 -15
- package/docs/documents/api.html +40 -15
- package/docs/documents/features_3dtile.html +142 -45
- package/docs/documents/features_camera-animation.html +62 -5
- package/docs/documents/features_clipper.html +3 -0
- package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} +4 -1
- package/docs/documents/features_event.html +3 -0
- package/docs/documents/features_five.html +4 -0
- package/docs/documents/features_flowing-light-2d-pass.html +356 -0
- package/docs/documents/features_flowing-light-3d-pass.html +351 -0
- package/docs/documents/features_gaussian-blur-pass.html +182 -0
- package/docs/documents/features_gesture.html +4 -0
- package/docs/documents/features_get-screen-pixels.html +3 -0
- package/docs/documents/features_image-options.html +3 -0
- package/docs/documents/features_load-external-model.html +25 -2
- package/docs/documents/features_load-progress.html +110 -0
- package/docs/documents/features_material.html +341 -0
- package/docs/documents/features_mode.html +5 -0
- package/docs/documents/features_model.html +5 -1
- package/docs/documents/features_move-pano-effect.html +3 -0
- package/docs/documents/features_multi-work.html +3 -0
- package/docs/documents/features_pano-filter.html +122 -0
- package/docs/documents/features_pano-tile.html +34 -19
- package/docs/documents/features_pano-uv.html +82 -0
- package/docs/documents/features_parameter.html +76 -56
- package/docs/documents/features_plugin.html +105 -0
- package/docs/documents/features_postprocessing.html +22 -5
- package/docs/documents/features_raycast.html +4 -1
- package/docs/documents/features_request-proxy.html +3 -0
- package/docs/documents/features_screen-project.html +3 -0
- package/docs/documents/features_state.html +3 -0
- package/docs/documents/features_view-layer.html +158 -0
- package/docs/documents/features_work.html +63 -2
- package/docs/documents/glossary.html +31 -6
- package/docs/documents/intro.html +1 -1
- package/docs/documents/quick-start.html +1 -0
- package/docs/documents/release_notes_6.8.html +189 -0
- package/docs/documents/template.html +45 -4
- package/docs/functions/five.loadAt3d.html +1 -1
- package/docs/functions/five.loadB3dm.html +1 -1
- package/docs/functions/five.loadDome.html +1 -1
- package/docs/functions/five.loadDomez.html +1 -1
- package/docs/functions/five.loadFbx.html +1 -1
- package/docs/functions/five.loadGltf.html +1 -1
- package/docs/functions/five.loadPbm.html +1 -1
- package/docs/functions/five.loadPly.html +1 -1
- package/docs/functions/five.loadPnts.html +1 -1
- package/docs/functions/five.loadSplat.html +1 -1
- package/docs/functions/five.loadSpz.html +1 -1
- package/docs/functions/five.loadX3p.html +1 -1
- package/docs/functions/five.parseWork.html +1 -1
- package/docs/functions/vue.useFiveWorks.html +2 -2
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +11 -2
- package/docs/interfaces/five.AddableObject.html +1 -1
- package/docs/interfaces/five.AjaxOptions.html +1 -1
- package/docs/interfaces/five.BaseEvent.html +2 -2
- package/docs/interfaces/five.EventCallback.html +53 -47
- package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
- package/docs/interfaces/five.GestureEvent.html +2 -2
- package/docs/interfaces/five.ImageOptions.html +1 -1
- package/docs/interfaces/five.IntersectEvent.html +2 -2
- package/docs/interfaces/five.IntersectMesh.html +1 -1
- package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
- package/docs/interfaces/five.Intersection.html +4 -3
- package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
- package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +9 -9
- package/docs/interfaces/five.ModeChangeEvent.html +2 -2
- package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ModelEvent.html +2 -2
- package/docs/interfaces/five.ModelSceneEvent.html +2 -2
- package/docs/interfaces/five.ModelTileEvent.html +8 -0
- package/docs/interfaces/five.MovePanoOptions.html +7 -7
- package/docs/interfaces/five.NetworkAbortError.html +1 -1
- package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
- package/docs/interfaces/five.NetworkOptions.html +1 -1
- package/docs/interfaces/five.NetworkProxyError.html +1 -1
- package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
- package/docs/interfaces/five.NetworkResponseError.html +1 -1
- package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
- package/docs/interfaces/five.ObjectEvent.html +2 -2
- package/docs/interfaces/five.PBMClipperParameter.html +2 -2
- package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
- package/docs/interfaces/five.PBMCustomShaderSlots.html +2 -2
- package/docs/interfaces/five.PBMMaterial.html +1 -1
- package/docs/interfaces/five.PBMMeshMaterialParameters.html +5 -3
- package/docs/interfaces/five.PBMPanoDepth.html +5 -5
- package/docs/interfaces/five.PBMPanoFilterValue.html +6 -0
- package/docs/interfaces/five.PBMPanoPicture.html +8 -6
- package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -3
- package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
- package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
- package/docs/interfaces/five.PanoEvent.html +2 -2
- package/docs/interfaces/five.PanoTextureEvent.html +2 -2
- package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ParameterMaterialValue.html +42 -38
- package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
- package/docs/interfaces/five.ParameterValue.html +56 -52
- package/docs/interfaces/five.Pose.html +1 -1
- package/docs/interfaces/five.RenderEvent.html +2 -2
- package/docs/interfaces/five.ResolvedParameterValue.html +56 -52
- package/docs/interfaces/five.RgbaData.html +7 -0
- package/docs/interfaces/five.SplatData.html +2 -2
- package/docs/interfaces/five.State.html +1 -1
- package/docs/interfaces/five.StateEvent.html +2 -2
- package/docs/interfaces/five.TextureOptions.html +1 -1
- package/docs/interfaces/five.Tile3DOptions.html +2 -2
- package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
- package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ViewLayer.html +30 -26
- package/docs/interfaces/five.WorkCubeImage.html +1 -1
- package/docs/interfaces/five.WorkImage.html +1 -1
- package/docs/interfaces/five.WorkModel.html +8 -8
- package/docs/interfaces/five.WorkModelLayer.html +6 -6
- package/docs/interfaces/five.WorkObserver.html +27 -2
- package/docs/interfaces/five.WorkTile.html +1 -1
- package/docs/interfaces/five.WorksEvent.html +2 -2
- package/docs/interfaces/five.XRControllerEvent.html +2 -2
- package/docs/interfaces/five.XRGestureEvent.html +2 -2
- package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.XRSessionEvent.html +2 -2
- package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
- package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
- package/docs/interfaces/plugins.DynamicPathLinePluginController.html +1 -1
- package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
- package/docs/interfaces/plugins.ItemMaskController.html +1 -1
- package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.ItemMaskPluginType.State.html +1 -1
- package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
- package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
- package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
- package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
- package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
- package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
- package/docs/interfaces/plugins.TrajectoryController.html +1 -1
- package/docs/interfaces/react.FiveInjectionTypes.html +13 -13
- package/docs/modules/five.html +1 -1
- package/docs/modules.html +1 -1
- package/docs/types/five.ControllerEventTypes.html +27 -25
- package/docs/types/five.EasingFunction.html +1 -0
- package/docs/types/five.EventTypes.html +27 -25
- package/docs/types/five.FivePlugin.html +1 -1
- package/docs/types/five.FivePluginInit.html +1 -1
- package/docs/types/five.FivePluginInstance.html +1 -1
- package/docs/types/five.NetworkProgressCallback.html +1 -1
- package/docs/types/five.PBMAlphaMode.html +1 -1
- package/docs/types/five.PBMColorStyle.html +1 -1
- package/docs/types/five.PBMFloorStyle.html +1 -1
- package/docs/types/five.PBMMeshShaderType.html +1 -1
- package/docs/types/five.PBMPointBack.html +1 -1
- package/docs/types/five.PBMPointCloudShaderType.html +1 -1
- package/docs/types/five.PBMPointShape.html +1 -1
- package/docs/types/five.PBMPointSize.html +1 -1
- package/docs/types/five.PBMTransition.html +1 -1
- package/docs/types/five.ParseOptions.html +6 -6
- package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
- package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
- package/five/application/analysis.d.ts +40 -0
- package/five/application/controllers.d.ts +41 -0
- package/five/application/events-legacy.d.ts +454 -0
- package/five/application/events.d.ts +69 -0
- package/five/application/five.d.ts +519 -0
- package/five/application/fiveInitArgs.d.ts +176 -0
- package/five/application/fiveLoadOptions.d.ts +21 -0
- package/five/application/generateDefaultVideoElement.d.ts +2 -0
- package/five/application/getViewportScale.d.ts +2 -0
- package/five/application/initLights.d.ts +3 -0
- package/five/application/mode.d.ts +28 -0
- package/five/application/renderPoweredByRealsee.d.ts +3 -0
- package/five/assets/cardboard-png-data-url.d.ts +2 -0
- package/five/assets/gradient-png-data-url.d.ts +2 -0
- package/five/assets/loading-png-data-url.d.ts +2 -0
- package/five/assets/phone-png-data-url.d.ts +2 -0
- package/five/assets/realsee-png-data-url.d.ts +2 -0
- package/five/bvh/bvhMath.d.ts +33 -0
- package/five/bvh/bvhMesh.d.ts +7 -0
- package/five/bvh/bvhNode.d.ts +29 -0
- package/five/bvh/bvhObject.d.ts +18 -0
- package/five/bvh/bvhPoints.d.ts +6 -0
- package/five/bvh/index.d.ts +10 -0
- package/five/bvh/worker.d.ts +35 -0
- package/five/cardboard/helper.d.ts +2 -0
- package/five/cardboard/index.d.ts +13 -0
- package/five/cardboard/sensor.d.ts +158 -0
- package/five/certificates/hardware.d.ts +1 -0
- package/five/controllers/base.d.ts +167 -0
- package/five/controllers/events.d.ts +71 -0
- package/five/controllers/floorplan.d.ts +119 -0
- package/five/controllers/mapview.d.ts +139 -0
- package/five/controllers/model.d.ts +57 -0
- package/five/controllers/panorama.d.ts +143 -0
- package/five/controllers/panoramaLike.d.ts +87 -0
- package/five/controllers/topview.d.ts +42 -0
- package/five/controllers/vrPanorama.d.ts +56 -0
- package/five/controllers/xrPanorama.d.ts +81 -0
- package/five/core/camera.d.ts +65 -0
- package/five/core/internalWebGLRenderer.d.ts +14 -0
- package/five/core/panoVideo.d.ts +18 -0
- package/five/core/scene.d.ts +10 -0
- package/five/core/tiling.d.ts +43 -0
- package/five/declare.d.ts +2 -1
- package/five/gaussian-splatting/util/renderData.d.ts +52 -0
- package/five/gaussian-splatting/wasm/data.d.ts +20 -0
- package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
- package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
- package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
- package/five/index.d.ts +60 -4637
- package/five/index.js +193 -341
- package/five/index.mjs +26455 -31011
- package/five/meshes/boundingMesh.d.ts +12 -0
- package/five/meshes/intersectMesh.d.ts +8 -0
- package/five/meshes/panoCircleMesh.d.ts +35 -0
- package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
- package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
- package/five/meshes/panoSphereMesh.d.ts +27 -0
- package/five/model/helpers/coordinate-transform.d.ts +3 -0
- package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
- package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
- package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
- package/five/model/index.d.ts +70 -0
- package/five/model/intersection.d.ts +18 -0
- package/five/model/loaders/at3d.d.ts +12 -0
- package/five/model/loaders/b3dm.d.ts +9 -0
- package/five/model/loaders/dome.d.ts +22 -0
- package/five/model/loaders/domez.d.ts +11 -0
- package/five/model/loaders/fbx.d.ts +8 -0
- package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
- package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
- package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +9 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
- package/five/model/loaders/glTF-helpers/extensions/base.d.ts +24 -0
- package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
- package/five/model/loaders/glTF-helpers/index.d.ts +47 -0
- package/five/model/loaders/glTF-helpers/parser.d.ts +114 -0
- package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
- package/five/model/loaders/gltf.d.ts +10 -0
- package/five/model/loaders/obj.d.ts +9 -0
- package/five/model/loaders/pbm.d.ts +26 -0
- package/five/model/loaders/ply.d.ts +24 -0
- package/five/model/loaders/pnts.d.ts +8 -0
- package/five/model/loaders/protobuf/dome.d.ts +540 -0
- package/five/model/loaders/protobuf/pbm.d.ts +203 -0
- package/five/model/loaders/shared.d.ts +16 -0
- package/five/model/loaders/splat.d.ts +8 -0
- package/five/model/loaders/spz.d.ts +14 -0
- package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
- package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
- package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
- package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
- package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
- package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
- package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
- package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
- package/five/model/loaders/x3p.d.ts +22 -0
- package/five/model/materials/pbmMaterial.d.ts +137 -0
- package/five/model/materials/pbmMeshMaterial.d.ts +126 -0
- package/five/model/materials/pbmPointCloudMaterial.d.ts +70 -0
- package/five/model/model-scene.d.ts +172 -0
- package/five/model/model.d.ts +209 -0
- package/five/model/objects/pbmContainer.d.ts +28 -0
- package/five/model/objects/pbmGaussianSplattingObject.d.ts +43 -0
- package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +55 -0
- package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -0
- package/five/model/objects/pbmGroup.d.ts +8 -0
- package/five/model/objects/pbmMesh.d.ts +10 -0
- package/five/model/objects/pbmPointCloud.d.ts +7 -0
- package/five/model/parameter.d.ts +140 -0
- package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
- package/five/model/tile3d/header.d.ts +88 -0
- package/five/model/tile3d/index.d.ts +214 -0
- package/five/model/tile3d/tile-cache.d.ts +18 -0
- package/five/model/tile3d/tile-content.d.ts +10 -0
- package/five/model/tile3d/tile-node.d.ts +24 -0
- package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
- package/five/model/tile3d/tile.d.ts +79 -0
- package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
- package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
- package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
- package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
- package/five/model/tile3d/tileset.d.ts +69 -0
- package/five/model/tile3d/trajectory-content.d.ts +9 -0
- package/five/model/tile3d/trajectory-node.d.ts +15 -0
- package/five/model/tile3d/trajectory.d.ts +30 -0
- package/five/model/tile3d/types.d.ts +33 -0
- package/five/model/view-layer.d.ts +20 -0
- package/five/renderer/five-renderer.d.ts +17 -0
- package/five/renderer/index.d.ts +3 -0
- package/five/renderer/postprocessing/composer.d.ts +37 -0
- package/five/renderer/postprocessing/index.d.ts +7 -0
- package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +17 -0
- package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
- package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
- package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
- package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
- package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
- package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
- package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
- package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
- package/five/renderer/tools/full-screen-quad.d.ts +15 -0
- package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
- package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
- package/five/renderer/tools/render-full-screen.d.ts +2 -0
- package/five/texture/histogram.d.ts +54 -0
- package/five/texture/imageBitmap.d.ts +13 -0
- package/five/texture/initTexture.d.ts +3 -0
- package/five/texture/loader.d.ts +39 -0
- package/five/texture/textureData.d.ts +11 -0
- package/five/thirdparty/fflate.d.ts +1407 -0
- package/five/thirdparty/hammer.d.ts +375 -0
- package/five/thirdparty/jsrsasign.d.ts +753 -0
- package/five/thirdparty/meshopt_decoder.d.ts +15 -0
- package/five/three-version-check.d.ts +1 -0
- package/five/types/addableObject.d.ts +12 -0
- package/five/types/cube.d.ts +1 -0
- package/five/types/gestureInput.d.ts +24 -0
- package/five/types/imageOptions.d.ts +20 -0
- package/five/types/intersectMeshInterface.d.ts +8 -0
- package/five/types/movePanoEffect.d.ts +13 -0
- package/five/types/movePanoOptions.d.ts +36 -0
- package/five/types/panoCircleMeshInterface.d.ts +34 -0
- package/five/types/plugin.d.ts +25 -0
- package/five/types/pose.d.ts +17 -0
- package/five/types/state.d.ts +20 -0
- package/five/types/viewport.d.ts +22 -0
- package/five/utils/ajax.d.ts +66 -0
- package/five/utils/animationFrameLoop.d.ts +45 -0
- package/five/utils/array.d.ts +31 -0
- package/five/utils/asyncTaskQueue.d.ts +8 -0
- package/five/utils/bufferGeometry.d.ts +33 -0
- package/five/utils/calculateProgress.d.ts +39 -0
- package/five/utils/calculateThreeMouse.d.ts +13 -0
- package/five/utils/canplayVideo.d.ts +2 -0
- package/five/utils/clamp.d.ts +2 -0
- package/five/utils/clock.d.ts +17 -0
- package/five/utils/createSymbol.d.ts +5 -0
- package/five/utils/decodeText.d.ts +2 -0
- package/five/utils/deepEqual.d.ts +2 -0
- package/five/utils/deepFreeze.d.ts +2 -0
- package/five/utils/defineProperty.d.ts +9 -0
- package/five/utils/detector.d.ts +14 -0
- package/five/utils/distance.d.ts +10 -0
- package/five/utils/draco.d.ts +26 -0
- package/five/utils/easing.d.ts +63 -0
- package/five/utils/event.d.ts +159 -0
- package/five/utils/formatRad.d.ts +7 -0
- package/five/utils/imageSupport.d.ts +6 -0
- package/five/utils/imageURL.d.ts +42 -0
- package/five/utils/isEmptyObject.d.ts +2 -0
- package/five/utils/isNil.d.ts +6 -0
- package/five/utils/isNumber.d.ts +2 -0
- package/five/utils/isPowerOfTwo.d.ts +2 -0
- package/five/utils/isPromise.d.ts +2 -0
- package/five/utils/isSimilar.d.ts +6 -0
- package/five/utils/json.d.ts +7 -0
- package/five/utils/ktx2.d.ts +30 -0
- package/five/utils/lzma/index.d.ts +2 -0
- package/five/utils/lzma/lzma.d.ts +3 -0
- package/five/utils/lzma/lzmaWASM.d.ts +2 -0
- package/five/utils/lzma/lzmaWorker.d.ts +14 -0
- package/five/utils/memoryUsage.d.ts +29 -0
- package/five/utils/motion.d.ts +38 -0
- package/five/utils/noop.d.ts +6 -0
- package/five/utils/now.d.ts +7 -0
- package/five/utils/pano.d.ts +9 -0
- package/five/utils/pick.d.ts +3 -0
- package/five/utils/poseUtils.d.ts +5 -0
- package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
- package/five/utils/renderDepth.d.ts +2 -0
- package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
- package/five/utils/requestPermission.d.ts +3 -0
- package/five/utils/shaderContentFix.d.ts +7 -0
- package/five/utils/shaderMaterial.d.ts +20 -0
- package/five/utils/stateUtils.d.ts +5 -0
- package/five/utils/string-pattern.d.ts +8 -0
- package/five/utils/subscribe.d.ts +67 -0
- package/five/utils/tileCube.d.ts +19 -0
- package/five/utils/toFastProperties.d.ts +1 -0
- package/five/utils/typedCache.d.ts +10 -0
- package/five/utils/uniform.d.ts +15 -0
- package/five/utils/url.d.ts +35 -0
- package/five/utils/uuid.d.ts +5 -0
- package/five/utils/values.d.ts +2 -0
- package/five/utils/vectorCoordinates.d.ts +29 -0
- package/five/utils/volume.d.ts +111 -0
- package/five/utils/webglError.d.ts +7 -0
- package/five/utils/worker.d.ts +26 -0
- package/five/webxr/XRControllerModelFactory.d.ts +28 -0
- package/five/webxr/motionHelper.d.ts +68 -0
- package/five/webxr/xrButton.d.ts +4 -0
- package/five/webxr/xrController.d.ts +24 -0
- package/five/webxr/xrManager.d.ts +84 -0
- package/five/work/_ALLOW_HOST.d.ts +2 -0
- package/five/work/index.d.ts +6 -0
- package/five/work/keychain.d.ts +5 -0
- package/five/work/looseWorkType.d.ts +121 -0
- package/five/work/verify.d.ts +7 -0
- package/five/work/work.d.ts +236 -0
- package/five/work/workFetcher.d.ts +4 -0
- package/five/work/workJson.d.ts +3 -0
- package/five/work/workJsonType.d.ts +73 -0
- package/five/work/workObserverUtils.d.ts +36 -0
- package/five/work/workParser.d.ts +6 -0
- package/five/work/workResolvedObserver.d.ts +12 -0
- package/five/work/workVerify.d.ts +2 -0
- package/five/work/works.d.ts +10 -0
- package/gltf-loader/gltf-object.d.ts +17 -0
- package/gltf-loader/index.d.ts +60 -160
- package/gltf-loader/index.js +9 -9
- package/gltf-loader/index.mjs +1351 -1451
- package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
- package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
- package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
- package/line/circle_png.d.ts +1 -0
- package/line/index.d.ts +19 -69
- package/line/index.js +4 -4
- package/line/index.mjs +334 -513
- package/line/utils/Line2.d.ts +7 -0
- package/line/utils/LineGeometry.d.ts +10 -0
- package/line/utils/LineMaterial.d.ts +20 -0
- package/line/utils/LineSegments2.d.ts +11 -0
- package/line/utils/LineSegmentsGeometry.d.ts +15 -0
- package/llms.txt +43 -31
- package/package.json +11 -2
- package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
- package/plugins/BackgroundPlugin/index.d.ts +5 -0
- package/plugins/BackgroundPlugin/typings.d.ts +44 -0
- package/plugins/BasePlugin/index.d.ts +119 -0
- package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
- package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
- package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
- package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
- package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
- package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
- package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
- package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
- package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
- package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
- package/plugins/ItemMaskPlugin/index.d.ts +5 -0
- package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
- package/plugins/OrientationPlugin/Controller.d.ts +82 -0
- package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
- package/plugins/OrientationPlugin/index.d.ts +6 -0
- package/plugins/OrientationPlugin/typing.d.ts +25 -0
- package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
- package/plugins/PanoAnimePlugin/index.d.ts +5 -0
- package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
- package/plugins/PluginTemplate/Controller.d.ts +27 -0
- package/plugins/PluginTemplate/index.d.ts +5 -0
- package/plugins/PluginTemplate/typing.d.ts +21 -0
- package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
- package/plugins/TrajectoryPlugin/index.d.ts +6 -0
- package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
- package/plugins/index.d.ts +9 -1102
- package/plugins/index.js +17 -21
- package/plugins/index.mjs +3342 -4245
- package/plugins/thirdParty/CSS3DRenderer.d.ts +32 -0
- package/plugins/thirdParty/OrbitControls.d.ts +78 -0
- package/plugins/utils/absoluteUrl.d.ts +5 -0
- package/plugins/utils/clamp.d.ts +2 -0
- package/plugins/utils/loadImage.d.ts +1 -0
- package/plugins/utils/motion.d.ts +38 -0
- package/plugins/utils/now.d.ts +6 -0
- package/plugins/utils/uuid.d.ts +5 -0
- package/react/canvas.d.ts +19 -0
- package/react/context.d.ts +11 -0
- package/react/createProvider.d.ts +95 -0
- package/react/createStore.d.ts +144 -0
- package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
- package/react/hooks/useFiveAction.d.ts +147 -0
- package/react/hooks/useFiveCameraDirection.d.ts +7 -0
- package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
- package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
- package/react/hooks/useFiveCurrentState.d.ts +15 -0
- package/react/hooks/useFiveEventCallback.d.ts +12 -0
- package/react/hooks/useFiveFloor.d.ts +15 -0
- package/react/hooks/useFiveHelper.d.ts +14 -0
- package/react/hooks/useFiveModelBounding.d.ts +5 -0
- package/react/hooks/useFiveModelEffect.d.ts +14 -0
- package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
- package/react/hooks/useFiveModelReadyState.d.ts +8 -0
- package/react/hooks/useFiveProject2d.d.ts +20 -0
- package/react/hooks/useFiveSceneEffect.d.ts +21 -0
- package/react/hooks/useFiveState.d.ts +6 -0
- package/react/hooks/useFiveWork.d.ts +29 -0
- package/react/index.d.ts +24 -830
- package/react/index.js +3 -3
- package/react/index.mjs +572 -783
- package/react/rendererPool.d.ts +7 -0
- package/react/withFive.d.ts +213 -0
- package/shader-lib/EvenessPlane/index.d.ts +10 -0
- package/shader-lib/PointCloudExpand/index.d.ts +59 -0
- package/shader-lib/PolygonCuter/index.d.ts +52 -0
- package/shader-lib/PolygonCuter/worker.d.ts +14 -0
- package/shader-lib/ShineModel/index.d.ts +7 -0
- package/shader-lib/SweepModel/index.d.ts +7 -0
- package/shader-lib/index.d.ts +5 -86
- package/shader-lib/index.js +13 -14
- package/shader-lib/index.mjs +424 -824
- package/sticker/geometry.d.ts +3 -0
- package/sticker/index.d.ts +68 -71
- package/sticker/index.js +3 -3
- package/sticker/index.mjs +102 -142
- package/umd/five-gltf-loader.js +9 -9
- package/umd/five-line.js +4 -4
- package/umd/five-plugins.js +17 -21
- package/umd/five-react.js +3 -3
- package/umd/five-shader-lib.js +13 -14
- package/umd/five-sticker.js +3 -3
- package/umd/five-vfx.js +21 -21
- package/umd/five-vue.js +3 -3
- package/umd/five.js +188 -336
- package/vfx/airflow/airflow.d.ts +18 -0
- package/vfx/airflow/fragment-shader.d.ts +2 -0
- package/vfx/airflow/vertex-shader.d.ts +2 -0
- package/vfx/common/scale-shader.d.ts +2 -0
- package/vfx/common/simplex-noise-shader.d.ts +2 -0
- package/vfx/frame/fragment-shader.d.ts +2 -0
- package/vfx/frame/frame.d.ts +22 -0
- package/vfx/frame/vertex-shader.d.ts +2 -0
- package/vfx/index.d.ts +7 -363
- package/vfx/index.js +21 -21
- package/vfx/index.mjs +454 -910
- package/vfx/particle/fragment-shader.d.ts +2 -0
- package/vfx/particle/instance.d.ts +36 -0
- package/vfx/particle/particle.d.ts +205 -0
- package/vfx/particle/utils.d.ts +11 -0
- package/vfx/particle/vertex-shader.d.ts +2 -0
- package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
- package/vfx/particle-gpu/instance.d.ts +36 -0
- package/vfx/particle-gpu/particle.d.ts +95 -0
- package/vfx/particle-gpu/utils.d.ts +11 -0
- package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
- package/vfx/spotLight/fragment-shader.d.ts +2 -0
- package/vfx/spotLight/spotLight.d.ts +15 -0
- package/vfx/spotLight/vertex-shader.d.ts +2 -0
- package/vue/context.d.ts +7 -0
- package/vue/hooks/FiveCanvas.d.ts +36 -0
- package/vue/hooks/FiveProvider.d.ts +35 -0
- package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
- package/vue/hooks/useFiveAction.d.ts +178 -0
- package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
- package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
- package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
- package/vue/hooks/useFiveCurrentState.d.ts +16 -0
- package/vue/hooks/useFiveEventCallback.d.ts +11 -0
- package/vue/hooks/useFiveFloor.d.ts +16 -0
- package/vue/hooks/useFiveHelper.d.ts +15 -0
- package/vue/hooks/useFiveModel.d.ts +7 -0
- package/vue/hooks/useFiveModelBounding.d.ts +7 -0
- package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
- package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
- package/vue/hooks/useFiveProject2d.d.ts +26 -0
- package/vue/hooks/useFiveScene.d.ts +6 -0
- package/vue/hooks/useFiveState.d.ts +16 -0
- package/vue/hooks/useFiveWork.d.ts +30 -0
- package/vue/index.d.ts +23 -467
- package/vue/index.js +3 -3
- package/vue/index.mjs +309 -301
- package/vue/rendererPool.d.ts +10 -0
- package/work-downloader/components/model-3d-tile.d.ts +2 -0
- package/work-downloader/components/model.d.ts +3 -0
- package/work-downloader/components/observer.d.ts +7 -0
- package/work-downloader/download.d.ts +16 -0
- package/work-downloader/index.d.ts +2 -33
- package/work-downloader/index.js +3 -3
- package/work-downloader/index.mjs +317 -556
- package/work-downloader/type.d.ts +28 -0
- package/work-downloader/utils/download-to-file.d.ts +1 -0
- package/work-downloader/utils/image-processing.d.ts +7 -0
- package/work-downloader/utils/join-url.d.ts +2 -0
- package/work-downloader/utils/log.d.ts +1 -0
- package/work-downloader/utils/relative-url.d.ts +1 -0
- package/docs/documents/five.FivePlugin.plugin.html +0 -60
- package/docs/documents/plugin.html +0 -60
- package/docs/media/five.ts +0 -2881
- package/docs/media/pass.ts +0 -64
- package/guides/ai-doc-guidelines.md +0 -72
- package/guides/features/3dtile.md +0 -264
- package/guides/features/parameter.md +0 -178
- package/guides/plugin.md +0 -206
- /package/{guides → ai_guides}/release_notes/6.6.md +0 -0
- /package/{guides → ai_guides}/release_notes/6.7.md +0 -0
- /package/{guides → ai_guides}/support.md +0 -0
|
@@ -0,0 +1,753 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* The 'jsrsasign'(RSA-Sign JavaScript Library) License
|
|
4
|
+
*
|
|
5
|
+
* Copyright (c) 2010-2021 Kenji Urushima
|
|
6
|
+
*
|
|
7
|
+
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
8
|
+
* of this software and associated documentation files (the "Software"), to deal
|
|
9
|
+
* in the Software without restriction, including without limitation the rights
|
|
10
|
+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
11
|
+
* copies of the Software, and to permit persons to whom the Software is
|
|
12
|
+
* furnished to do so, subject to the following conditions:
|
|
13
|
+
*
|
|
14
|
+
* The above copyright notice and this permission notice shall be included in
|
|
15
|
+
* all copies or substantial portions of the Software.
|
|
16
|
+
*
|
|
17
|
+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
18
|
+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
19
|
+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
20
|
+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
21
|
+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
22
|
+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
23
|
+
* THE SOFTWARE.
|
|
24
|
+
*
|
|
25
|
+
* LICENSE: MIT License
|
|
26
|
+
*/
|
|
27
|
+
/**
|
|
28
|
+
* @license
|
|
29
|
+
* RSA and ECC in JavaScript
|
|
30
|
+
*
|
|
31
|
+
* Copyright (c) 2003-2005 Tom Wu All Rights Reserved.
|
|
32
|
+
*
|
|
33
|
+
* Permission is hereby granted, free of charge, to any person obtaining
|
|
34
|
+
* a copy of this software and associated documentation files (the
|
|
35
|
+
* "Software"), to deal in the Software without restriction, including
|
|
36
|
+
* without limitation the rights to use, copy, modify, merge, publish,
|
|
37
|
+
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
38
|
+
* permit persons to whom the Software is furnished to do so, subject to
|
|
39
|
+
* the following conditions:
|
|
40
|
+
*
|
|
41
|
+
* The above copyright notice and this permission notice shall be
|
|
42
|
+
* included in all copies or substantial portions of the Software.
|
|
43
|
+
*
|
|
44
|
+
* THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
|
|
45
|
+
* EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
|
|
46
|
+
* WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|
|
47
|
+
*
|
|
48
|
+
* IN NO EVENT SHALL TOM WU BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
|
|
49
|
+
* INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER
|
|
50
|
+
* RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF
|
|
51
|
+
* THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT
|
|
52
|
+
* OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
53
|
+
*
|
|
54
|
+
* In addition, the following condition applies:
|
|
55
|
+
*
|
|
56
|
+
* All redistributions must retain an intact copy of this copyright notice
|
|
57
|
+
* and disclaimer.
|
|
58
|
+
*
|
|
59
|
+
* http://www-cs-students.stanford.edu/~tjw/jsbn/
|
|
60
|
+
* LICENSE: BSD License
|
|
61
|
+
* PART: ext/{base64,jsbn,jsbn2,prgn4,rng,rsa,rsa2}
|
|
62
|
+
*/
|
|
63
|
+
/**
|
|
64
|
+
* @license
|
|
65
|
+
* CryptoJS
|
|
66
|
+
*
|
|
67
|
+
* Copyright (c) 2009-2013 Jeff Mott
|
|
68
|
+
*
|
|
69
|
+
* Permission is hereby granted, free of charge, to any person obtaining
|
|
70
|
+
* a copy of this software and associated documentation files (the
|
|
71
|
+
* "Software"), to deal in the Software without restriction, including
|
|
72
|
+
* without limitation the rights to use, copy, modify, merge, publish,
|
|
73
|
+
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
74
|
+
* permit persons to whom the Software is furnished to do so, subject to
|
|
75
|
+
* the following conditions:
|
|
76
|
+
*
|
|
77
|
+
* The above copyright notice and this permission notice shall be
|
|
78
|
+
* included in all copies or substantial portions of the Software.
|
|
79
|
+
*
|
|
80
|
+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
81
|
+
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
82
|
+
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
83
|
+
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
84
|
+
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
85
|
+
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
86
|
+
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
87
|
+
*
|
|
88
|
+
* https://code.google.com/p/crypto-js/wiki/License
|
|
89
|
+
* PART: ext/cryptojs
|
|
90
|
+
*/
|
|
91
|
+
declare function hex2b64(d: any): string;
|
|
92
|
+
declare function b64tohex(f: any): string;
|
|
93
|
+
declare function hextopem(a: any, b: any): string;
|
|
94
|
+
declare function pemtohex(a: any, b: any): string;
|
|
95
|
+
|
|
96
|
+
declare namespace KJUR {
|
|
97
|
+
namespace crypto {
|
|
98
|
+
export type DSA = any;
|
|
99
|
+
export type ECDSA = any;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
interface ECCPrivateKey {
|
|
103
|
+
curve: string;
|
|
104
|
+
d: string;
|
|
105
|
+
}
|
|
106
|
+
interface pemtohex {
|
|
107
|
+
(pem: string): string;
|
|
108
|
+
}
|
|
109
|
+
interface hextopem {
|
|
110
|
+
(pem: string, shead: string): string;
|
|
111
|
+
}
|
|
112
|
+
interface b64tohex {
|
|
113
|
+
(pem: string): string;
|
|
114
|
+
}
|
|
115
|
+
interface hex2b64 {
|
|
116
|
+
(pem: string): string;
|
|
117
|
+
}
|
|
118
|
+
/** Tom Wu's RSA Key class and extension */
|
|
119
|
+
declare class RSAKey {
|
|
120
|
+
constructor();
|
|
121
|
+
/**
|
|
122
|
+
* static method to get array of hex field values from hexadecimal PKCS#5 RSA private key.
|
|
123
|
+
* @param sPEMPrivateKey PEM PKCS#1/5 s private key string
|
|
124
|
+
* @return array of field hex value
|
|
125
|
+
* @example
|
|
126
|
+
* RSAKey.getHexValueArrayOfChildrenFromHex("3082...") → ["00", "3b42...", ...]
|
|
127
|
+
*/
|
|
128
|
+
static getHexValueArrayOfChildrenFromHex(sPEMPrivateKey: string): string[];
|
|
129
|
+
/**
|
|
130
|
+
* static method to get array of field positions from hexadecimal PKCS#5 RSA private key.
|
|
131
|
+
* @param sPEMPrivateKey PEM PKCS#1/5 s private key string
|
|
132
|
+
* @return array of field positions
|
|
133
|
+
* @example
|
|
134
|
+
* RSAKey.getPosArrayOfChildrenFromHex("3082...") → [8, 32, ...]
|
|
135
|
+
*/
|
|
136
|
+
static getPosArrayOfChildrenFromHex(sPEMPrivateKey: string): number[];
|
|
137
|
+
/**
|
|
138
|
+
* read an ASN.1 hexadecimal string of X.509 RSA public key certificate
|
|
139
|
+
* @param h hexadecimal string of X.509 RSA public key certificate
|
|
140
|
+
* @param nthPKI nth index of publicKeyInfo. (DEFAULT: 6 for X509v3)
|
|
141
|
+
*/
|
|
142
|
+
readCertPubKeyHex(h: string, nthPKI: number): void;
|
|
143
|
+
/**
|
|
144
|
+
* read an ASN.1 hexadecimal string of PKCS#1/5 plain RSA private key
|
|
145
|
+
* @param h hexadecimal string of PKCS#1/5 plain RSA private key
|
|
146
|
+
*/
|
|
147
|
+
readPKCS5PrvKeyHex(h: string): void;
|
|
148
|
+
/**
|
|
149
|
+
* read an ASN.1 hexadecimal string of PKCS#5 RSA public key
|
|
150
|
+
* @param h hexadecimal string of PKCS#5 public key
|
|
151
|
+
*/
|
|
152
|
+
readPKCS5PubKeyHex(h: string): void;
|
|
153
|
+
/**
|
|
154
|
+
* read an ASN.1 hexadecimal string of PKCS#8 plain RSA private key
|
|
155
|
+
* @param h hexadecimal string of PKCS#8 plain RSA private key
|
|
156
|
+
*/
|
|
157
|
+
readPKCS8PrvKeyHex(h: string): void;
|
|
158
|
+
/**
|
|
159
|
+
* read an ASN.1 hexadecimal string of PKCS#8 RSA public key
|
|
160
|
+
* @param h hexadecimal string of PKCS#8 public key
|
|
161
|
+
*/
|
|
162
|
+
readPKCS8PubKeyHex(h: string): void;
|
|
163
|
+
/**
|
|
164
|
+
* read PKCS#1 private key from a string
|
|
165
|
+
* @param keyPEM string of PKCS#1 private key.
|
|
166
|
+
*/
|
|
167
|
+
readPrivateKeyFromPEMString(keyPEM: string): void;
|
|
168
|
+
/**
|
|
169
|
+
* verifies a sigature for a message string with RSA public key.
|
|
170
|
+
* @param sMsg message string to be verified.
|
|
171
|
+
* @param hSig hexadecimal string of signature.
|
|
172
|
+
* non-hexadecimal characters including new lines will be ignored.
|
|
173
|
+
* @return returns 1 if valid, otherwise 0
|
|
174
|
+
*/
|
|
175
|
+
verify(sMsg: string, hSig: string): 0 | 1;
|
|
176
|
+
/**
|
|
177
|
+
* verifies a sigature for a message string with RSA public key by PKCS#1 PSS sign.
|
|
178
|
+
* @param sMsg message string to be verified.
|
|
179
|
+
* @param hSig hexadecimal string of signature value
|
|
180
|
+
* @param hashAlg hash algorithm name
|
|
181
|
+
* @param sLen salt byte length from 0 to (keybytelen - hashbytelen - 2).
|
|
182
|
+
* There are two special values:
|
|
183
|
+
* * -1: sets the salt length to the digest length
|
|
184
|
+
* * -2: sets the salt length to maximum permissible value
|
|
185
|
+
* (i.e. keybytelen - hashbytelen - 2)
|
|
186
|
+
*
|
|
187
|
+
* DEFAULT is -1. (NOTE: OpenSSL's default is -2.)
|
|
188
|
+
* @return returns true if valid, otherwise false
|
|
189
|
+
*/
|
|
190
|
+
static verifyPSS(sMsg: string, hSig: string, hashAlg: string, sLen: number): boolean;
|
|
191
|
+
/**
|
|
192
|
+
* verifies a sigature for a message string with RSA public key.
|
|
193
|
+
* @param sHashHex hexadecimal hash value of message to be verified.
|
|
194
|
+
* @param hSig hexadecimal string of signature.
|
|
195
|
+
* non-hexadecimal charactors including new lines will be ignored.
|
|
196
|
+
* @return returns 1 if valid, otherwise 0
|
|
197
|
+
*/
|
|
198
|
+
static verifyWithMessageHash(sHashHex: string, hSig: string): 0 | 1;
|
|
199
|
+
/**
|
|
200
|
+
* verifies a sigature for a hash value of message string with RSA public key by PKCS#1 PSS sign.
|
|
201
|
+
* @param hHash hexadecimal hash value of message string to be verified.
|
|
202
|
+
* @param hSig hexadecimal string of signature value
|
|
203
|
+
* @param hashAlg hash algorithm name
|
|
204
|
+
* @param sLen salt byte length from 0 to (keybytelen - hashbytelen - 2).
|
|
205
|
+
* There are two special values:
|
|
206
|
+
* * -1: sets the salt length to the digest length
|
|
207
|
+
* * -2: sets the salt length to maximum permissible value
|
|
208
|
+
* (i.e. keybytelen - hashbytelen - 2)
|
|
209
|
+
*
|
|
210
|
+
* DEFAULT is -1 (NOTE: OpenSSL's default is -2.)
|
|
211
|
+
* @return returns true if valid, otherwise false
|
|
212
|
+
*/
|
|
213
|
+
static verifyWithMessageHashPSS(hHash: string, hSig: string, hashAlg: string, sLen: number): boolean;
|
|
214
|
+
}
|
|
215
|
+
interface X509Extension {
|
|
216
|
+
oid: string;
|
|
217
|
+
critical: boolean;
|
|
218
|
+
vidx: number;
|
|
219
|
+
}
|
|
220
|
+
interface PublicKeyInfoPropOfCertPEMResult {
|
|
221
|
+
/** hexadecimal string of OID of asymmetric key algorithm */
|
|
222
|
+
algoid: string;
|
|
223
|
+
/** hexadecimal string of OID of ECC curve name or null */
|
|
224
|
+
algparam: string | null;
|
|
225
|
+
/** hexadecimal string of key in the certificate */
|
|
226
|
+
keyhex: string;
|
|
227
|
+
}
|
|
228
|
+
declare class X509 {
|
|
229
|
+
hex: string;
|
|
230
|
+
static readonly version: string;
|
|
231
|
+
constructor();
|
|
232
|
+
/**
|
|
233
|
+
* get format version (X.509v1 or v3 certificate)
|
|
234
|
+
* @return 1 for X509v1, 3 for X509v3, otherwise 0
|
|
235
|
+
* @description
|
|
236
|
+
* This method returns a format version of X.509 certificate.
|
|
237
|
+
* It returns 1 for X.509v1 certificate and 3 for v3 certificate.
|
|
238
|
+
* Otherwise returns 0.
|
|
239
|
+
* This method will be automatically called in
|
|
240
|
+
* `X509#readCertPEM`. After then, you can use
|
|
241
|
+
* `X509.version` parameter.
|
|
242
|
+
* @example
|
|
243
|
+
* var x = new X509();
|
|
244
|
+
* x.readCertPEM(sCertPEM);
|
|
245
|
+
* version = x.getVersion(); // 1 or 3
|
|
246
|
+
* sn = x.getSerialNumberHex(); // return string like "01ad..."
|
|
247
|
+
*/
|
|
248
|
+
getVersion(): number;
|
|
249
|
+
/**
|
|
250
|
+
* get hexadecimal string of serialNumber field of certificate.
|
|
251
|
+
* @return hexadecimal string of certificate serial number
|
|
252
|
+
* @example
|
|
253
|
+
* var x = new X509();
|
|
254
|
+
* x.readCertPEM(sCertPEM);
|
|
255
|
+
* var sn = x.getSerialNumberHex(); // return string like "01ad..."
|
|
256
|
+
*/
|
|
257
|
+
getSerialNumberHex(): string;
|
|
258
|
+
/**
|
|
259
|
+
* get signature algorithm name in basic field
|
|
260
|
+
* @return signature algorithm name (ex. SHA1withRSA, SHA256withECDSA)
|
|
261
|
+
* @description
|
|
262
|
+
* This method will get a name of signature algorithm field of certificate:
|
|
263
|
+
* @example
|
|
264
|
+
* var x = new X509();
|
|
265
|
+
* x.readCertPEM(sCertPEM);
|
|
266
|
+
* algName = x.getSignatureAlgorithmField();
|
|
267
|
+
*/
|
|
268
|
+
getSignatureAlgorithmField(): string;
|
|
269
|
+
/**
|
|
270
|
+
* get hexadecimal string of issuer field TLV of certificate.
|
|
271
|
+
* @return hexadecial string of issuer DN ASN.1
|
|
272
|
+
* @example
|
|
273
|
+
* var x = new X509();
|
|
274
|
+
* x.readCertPEM(sCertPEM);
|
|
275
|
+
* var issuer = x.getIssuerHex(); // return string like "3013..."
|
|
276
|
+
*/
|
|
277
|
+
getIssuerHex(): string;
|
|
278
|
+
/**
|
|
279
|
+
* get string of issuer field of certificate.
|
|
280
|
+
* @return issuer DN string
|
|
281
|
+
* @example
|
|
282
|
+
* var x = new X509();
|
|
283
|
+
* x.readCertPEM(sCertPEM);
|
|
284
|
+
* var issuer = x.getIssuerString(); // return string like "/C=US/O=TEST"
|
|
285
|
+
*/
|
|
286
|
+
getIssuerString(): string;
|
|
287
|
+
/**
|
|
288
|
+
* get hexadecimal string of subject field of certificate.
|
|
289
|
+
* @return hexadecial string of subject DN ASN.1
|
|
290
|
+
* @example
|
|
291
|
+
* var x = new X509();
|
|
292
|
+
* x.readCertPEM(sCertPEM);
|
|
293
|
+
* var subject = x.getSubjectHex(); // return string like "3013..."
|
|
294
|
+
*/
|
|
295
|
+
getSubjectHex(): string;
|
|
296
|
+
/**
|
|
297
|
+
* get string of subject field of certificate.
|
|
298
|
+
* @return subject DN string
|
|
299
|
+
* @example
|
|
300
|
+
* var x = new X509();
|
|
301
|
+
* x.readCertPEM(sCertPEM);
|
|
302
|
+
* var subject = x.getSubjectString(); // return string like "/C=US/O=TEST"
|
|
303
|
+
*/
|
|
304
|
+
getSubjectString(): string;
|
|
305
|
+
/**
|
|
306
|
+
* get notBefore field string of certificate.
|
|
307
|
+
* @return not before time value (ex. "151231235959Z")
|
|
308
|
+
* @example
|
|
309
|
+
* var x = new X509();
|
|
310
|
+
* x.readCertPEM(sCertPEM);
|
|
311
|
+
* var notBefore = x.getNotBefore(); // return string like "151231235959Z"
|
|
312
|
+
*/
|
|
313
|
+
getNotBefore(): string;
|
|
314
|
+
/**
|
|
315
|
+
* get notAfter field string of certificate.
|
|
316
|
+
* @return not after time value (ex. "151231235959Z")
|
|
317
|
+
* @example
|
|
318
|
+
* var x = new X509();
|
|
319
|
+
* x.readCertPEM(sCertPEM);
|
|
320
|
+
* var notAfter = x.getNotAfter(); // return string like "151231235959Z"
|
|
321
|
+
*/
|
|
322
|
+
getNotAfter(): string;
|
|
323
|
+
/**
|
|
324
|
+
* get a hexadecimal string of subjectPublicKeyInfo field.
|
|
325
|
+
* @return ASN.1 SEQUENCE hexadecimal string of subjectPublicKeyInfo field
|
|
326
|
+
* @example
|
|
327
|
+
* x = new X509();
|
|
328
|
+
* x.readCertPEM(sCertPEM);
|
|
329
|
+
* hSPKI = x.getPublicKeyHex(); // return string like "30820122..."
|
|
330
|
+
*/
|
|
331
|
+
getPublicKeyHex(): string;
|
|
332
|
+
/**
|
|
333
|
+
* get a string index of subjectPublicKeyInfo field for hexadecimal string certificate.
|
|
334
|
+
* @return string index of subjectPublicKeyInfo field for hexadecimal string certificate.
|
|
335
|
+
* @example
|
|
336
|
+
* x = new X509();
|
|
337
|
+
* x.readCertPEM(sCertPEM);
|
|
338
|
+
* idx = x.getPublicKeyIdx(); // return string index in x.hex parameter
|
|
339
|
+
*/
|
|
340
|
+
getPublicKeyIdx(): number;
|
|
341
|
+
/**
|
|
342
|
+
* get a string index of contents of subjectPublicKeyInfo BITSTRING value from hexadecimal certificate
|
|
343
|
+
* @return string index of key contents
|
|
344
|
+
* @example
|
|
345
|
+
* x = new X509();
|
|
346
|
+
* x.readCertPEM(sCertPEM);
|
|
347
|
+
* idx = x.getPublicKeyContentIdx(); // return string index in x.hex parameter
|
|
348
|
+
*/
|
|
349
|
+
getPublicKeyContentIdx(): number;
|
|
350
|
+
/**
|
|
351
|
+
* get a RSAKey/ECDSA/DSA public key object of subjectPublicKeyInfo field.
|
|
352
|
+
* @return RSAKey/ECDSA/DSA public key object of subjectPublicKeyInfo field
|
|
353
|
+
* @example
|
|
354
|
+
* x = new X509();
|
|
355
|
+
* x.readCertPEM(sCertPEM);
|
|
356
|
+
* pubkey = x.getPublicKey();
|
|
357
|
+
*/
|
|
358
|
+
getPublicKey(): RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA;
|
|
359
|
+
/**
|
|
360
|
+
* get signature algorithm name from hexadecimal certificate data
|
|
361
|
+
* @param hCert hexadecimal string of X.509 certificate binary
|
|
362
|
+
* @return signature algorithm name (ex. SHA1withRSA, SHA256withECDSA)
|
|
363
|
+
* @description
|
|
364
|
+
* This method will get signature algorithm name of certificate:
|
|
365
|
+
* @example
|
|
366
|
+
* var x = new X509();
|
|
367
|
+
* x.readCertPEM(sCertPEM);
|
|
368
|
+
* x.getSignatureAlgorithmName() → "SHA256withRSA"
|
|
369
|
+
*/
|
|
370
|
+
getSignatureAlgorithmName(): string;
|
|
371
|
+
/**
|
|
372
|
+
* get signature value in hexadecimal string
|
|
373
|
+
* @return signature value hexadecimal string without BitString unused bits
|
|
374
|
+
* @description
|
|
375
|
+
* This method will get signature value of certificate:
|
|
376
|
+
* @example
|
|
377
|
+
* var x = new X509();
|
|
378
|
+
* x.readCertPEM(sCertPEM);
|
|
379
|
+
* x.getSignatureValueHex() → "8a4c47913..."
|
|
380
|
+
*/
|
|
381
|
+
getSignatureValueHex(): string;
|
|
382
|
+
/**
|
|
383
|
+
* verifies signature value by public key
|
|
384
|
+
* @param pubKey public key object or hexadecimal string of X.509 certificate
|
|
385
|
+
* @return true if signature value is valid otherwise false
|
|
386
|
+
* @description
|
|
387
|
+
* This method verifies signature value of hexadecimal string of
|
|
388
|
+
* X.509 certificate by specified public key object.
|
|
389
|
+
* @example
|
|
390
|
+
* pubKey = KEYUTIL.getKey(pemPublicKey); // or certificate
|
|
391
|
+
* x = new X509();
|
|
392
|
+
* x.readCertPEM(pemCert);
|
|
393
|
+
* x.verifySignature(pubKey) → true, false or raising exception
|
|
394
|
+
*/
|
|
395
|
+
verifySignature(pubKey: string | RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA | ECCPrivateKey): boolean;
|
|
396
|
+
/**
|
|
397
|
+
* set array of X.509v3 extesion information such as extension OID, criticality and value index.
|
|
398
|
+
* @description
|
|
399
|
+
* This method will set an array of X.509v3 extension information having
|
|
400
|
+
* following parameters:
|
|
401
|
+
*
|
|
402
|
+
* - oid - extension OID (ex. 2.5.29.19)
|
|
403
|
+
* - critical - true or false
|
|
404
|
+
* - vidx - string index for extension value
|
|
405
|
+
*
|
|
406
|
+
* @example
|
|
407
|
+
* x = new X509();
|
|
408
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
409
|
+
*
|
|
410
|
+
* x.aExtInfo →
|
|
411
|
+
* [ { oid: "2.5.29,19", critical: true, vidx: 2504 }, ... ]
|
|
412
|
+
*/
|
|
413
|
+
parseExt(params: {
|
|
414
|
+
oid: string;
|
|
415
|
+
critical: boolean;
|
|
416
|
+
vidx: number;
|
|
417
|
+
}): void;
|
|
418
|
+
/**
|
|
419
|
+
* get a X.509v3 extesion information such as extension OID, criticality and value index for specified oid or name.
|
|
420
|
+
* @param oidOrName X.509 extension oid or name (ex. keyUsage or 2.5.29.19)
|
|
421
|
+
* @return X.509 extension information such as extension OID or value indx (see `X509#parseExt`)
|
|
422
|
+
* @description
|
|
423
|
+
* This method will get an X.509v3 extension information JSON object
|
|
424
|
+
* having extension OID, criticality and value idx for specified
|
|
425
|
+
* extension OID or name.
|
|
426
|
+
* If there is no such extension, this returns undefined.
|
|
427
|
+
* @example
|
|
428
|
+
* x = new X509();
|
|
429
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
430
|
+
*
|
|
431
|
+
* x.getExtInfo("keyUsage") → { oid: "2.5.29.15", critical: true, vidx: 1714 }
|
|
432
|
+
* x.getExtInfo("unknownExt") → undefined
|
|
433
|
+
*/
|
|
434
|
+
getExtInfo(oidOrName: string): X509Extension;
|
|
435
|
+
/**
|
|
436
|
+
* get BasicConstraints extension value as object in the certificate
|
|
437
|
+
* @return associative array which may have "cA" and "pathLen" parameters
|
|
438
|
+
* @description
|
|
439
|
+
* This method will get basic constraints extension value as object with following paramters.
|
|
440
|
+
*
|
|
441
|
+
* - cA - CA flag whether CA or not
|
|
442
|
+
* - pathLen - maximum intermediate certificate length
|
|
443
|
+
*
|
|
444
|
+
* There are use cases for return values:
|
|
445
|
+
*
|
|
446
|
+
* - {cA:true, pathLen:3} - cA flag is true and pathLen is 3
|
|
447
|
+
* - {cA:true} - cA flag is true and no pathLen
|
|
448
|
+
* - {} - basic constraints has no value in case of end entity certificate
|
|
449
|
+
* - undefined - there is no basic constraints extension
|
|
450
|
+
*
|
|
451
|
+
* @example
|
|
452
|
+
* x = new X509();
|
|
453
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
454
|
+
* x.getExtBasicConstraints() → { cA: true, pathLen: 3 };
|
|
455
|
+
*/
|
|
456
|
+
getExtBasicConstraints(): {
|
|
457
|
+
cA: boolean;
|
|
458
|
+
pathLen: number;
|
|
459
|
+
};
|
|
460
|
+
/**
|
|
461
|
+
* get KeyUsage extension value as binary string in the certificate
|
|
462
|
+
* @return binary string of key usage bits (ex. '101')
|
|
463
|
+
* @description
|
|
464
|
+
* This method will get key usage extension value
|
|
465
|
+
* as binary string such like '101'.
|
|
466
|
+
* Key usage bits definition is in the RFC 5280.
|
|
467
|
+
* If there is no key usage extension in the certificate,
|
|
468
|
+
* it returns empty string (i.e. '').
|
|
469
|
+
* @example
|
|
470
|
+
* x = new X509();
|
|
471
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
472
|
+
* x.getExtKeyUsageBin() → '101'
|
|
473
|
+
* // 1 - digitalSignature
|
|
474
|
+
* // 0 - nonRepudiation
|
|
475
|
+
* // 1 - keyEncipherment
|
|
476
|
+
*/
|
|
477
|
+
getExtKeyUsageBin(): string;
|
|
478
|
+
/**
|
|
479
|
+
* get KeyUsage extension value as names in the certificate
|
|
480
|
+
* @return comma separated string of key usage
|
|
481
|
+
* @description
|
|
482
|
+
* This method will get key usage extension value
|
|
483
|
+
* as comma separated string of usage names.
|
|
484
|
+
* If there is no key usage extension in the certificate,
|
|
485
|
+
* it returns empty string (i.e. '').
|
|
486
|
+
* @example
|
|
487
|
+
* x = new X509();
|
|
488
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
489
|
+
* x.getExtKeyUsageString() → "digitalSignature,keyEncipherment"
|
|
490
|
+
*/
|
|
491
|
+
getExtKeyUsageString(): string;
|
|
492
|
+
/**
|
|
493
|
+
* get subjectKeyIdentifier value as hexadecimal string in the certificate
|
|
494
|
+
* @return hexadecimal string of subject key identifier or null
|
|
495
|
+
* @description
|
|
496
|
+
* This method will get subject key identifier extension value
|
|
497
|
+
* as hexadecimal string.
|
|
498
|
+
* If there is this in the certificate, it returns undefined;
|
|
499
|
+
* @example
|
|
500
|
+
* x = new X509();
|
|
501
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
502
|
+
* x.getExtSubjectKeyIdentifier() → "1b3347ab...";
|
|
503
|
+
*/
|
|
504
|
+
getExtSubjectKeyIdentifier(): string;
|
|
505
|
+
/**
|
|
506
|
+
* get authorityKeyIdentifier value as JSON object in the certificate
|
|
507
|
+
* @return JSON object of authority key identifier or null
|
|
508
|
+
* @description
|
|
509
|
+
* This method will get authority key identifier extension value
|
|
510
|
+
* as JSON object.
|
|
511
|
+
* If there is this in the certificate, it returns undefined;
|
|
512
|
+
*
|
|
513
|
+
* NOTE: Currently this method only supports keyIdentifier so that
|
|
514
|
+
* authorityCertIssuer and authorityCertSerialNumber will not
|
|
515
|
+
* be return in the JSON object.
|
|
516
|
+
* @example
|
|
517
|
+
* x = new X509();
|
|
518
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
519
|
+
* x.getExtAuthorityKeyIdentifier() → { kid: "1234abcd..." }
|
|
520
|
+
*/
|
|
521
|
+
getExtAuthorityKeyIdentifier(): {
|
|
522
|
+
kid: string;
|
|
523
|
+
} | null;
|
|
524
|
+
/**
|
|
525
|
+
* get extKeyUsage value as array of name string in the certificate
|
|
526
|
+
* @return array of extended key usage ID name or oid
|
|
527
|
+
* @description
|
|
528
|
+
* This method will get extended key usage extension value
|
|
529
|
+
* as array of name or OID string.
|
|
530
|
+
* If there is this in the certificate, it returns undefined;
|
|
531
|
+
*
|
|
532
|
+
* NOTE: Supported extended key usage ID names are defined in
|
|
533
|
+
* name2oidList parameter in asn1x509.js file.
|
|
534
|
+
* @example
|
|
535
|
+
* x = new X509();
|
|
536
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
537
|
+
* x.getExtExtKeyUsageName() → ["serverAuth", "clientAuth", "0.1.2.3.4.5"]
|
|
538
|
+
*/
|
|
539
|
+
getExtExtKeyUsageName(): string[];
|
|
540
|
+
/**
|
|
541
|
+
* get subjectAltName value as array of string in the certificate
|
|
542
|
+
* @return array of alt name array
|
|
543
|
+
* @description
|
|
544
|
+
* This method will get subject alt name extension value
|
|
545
|
+
* as array of type and name.
|
|
546
|
+
* If there is this in the certificate, it returns undefined;
|
|
547
|
+
* Type of GeneralName will be shown as following:
|
|
548
|
+
*
|
|
549
|
+
* - "MAIL" - [1]rfc822Name
|
|
550
|
+
* - "DNS" - [2]dNSName
|
|
551
|
+
* - "DN" - [4]directoryName
|
|
552
|
+
* - "URI" - [6]uniformResourceIdentifier
|
|
553
|
+
* - "IP" - [7]iPAddress
|
|
554
|
+
*
|
|
555
|
+
* @example
|
|
556
|
+
* x = new X509();
|
|
557
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
558
|
+
* x.getExtSubjectAltName2() →
|
|
559
|
+
* [["DNS", "example.com"],
|
|
560
|
+
* ["DNS", "example.org"],
|
|
561
|
+
* ["MAIL", "foo@example.com"],
|
|
562
|
+
* ["IP", "192.168.1.1"],
|
|
563
|
+
* ["DN", "/C=US/O=TEST1"]]
|
|
564
|
+
*/
|
|
565
|
+
getExtSubjectAltName2(): string[][] | undefined;
|
|
566
|
+
/**
|
|
567
|
+
* get array of string for fullName URIs in cRLDistributionPoints(CDP) in the certificate
|
|
568
|
+
* @return array of fullName URIs of CDP of the certificate
|
|
569
|
+
* @description
|
|
570
|
+
* This method will get all fullName URIs of cRLDistributionPoints extension
|
|
571
|
+
* in the certificate as array of URI string.
|
|
572
|
+
* If there is this in the certificate, it returns undefined;
|
|
573
|
+
*
|
|
574
|
+
* NOTE: Currently this method supports only fullName URI so that
|
|
575
|
+
* other parameters will not be returned.
|
|
576
|
+
* @example
|
|
577
|
+
* x = new X509();
|
|
578
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
579
|
+
* x.getExtCRLDistributionPointsURI() →
|
|
580
|
+
* ["http://example.com/aaa.crl", "http://example.org/aaa.crl"]
|
|
581
|
+
*/
|
|
582
|
+
getExtCRLDistributionPointsURI(): string[] | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* get AuthorityInfoAccess extension value in the certificate as associative array
|
|
585
|
+
* @return associative array of AIA extension properties
|
|
586
|
+
* @description
|
|
587
|
+
* This method will get authority info access value
|
|
588
|
+
* as associate array which has following properties:
|
|
589
|
+
*
|
|
590
|
+
* - ocsp - array of string for OCSP responder URL
|
|
591
|
+
* - caissuer - array of string for caIssuer value (i.e. CA certificates URL)
|
|
592
|
+
*
|
|
593
|
+
* If there is this in the certificate, it returns undefined;
|
|
594
|
+
* @example
|
|
595
|
+
* x = new X509();
|
|
596
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
597
|
+
* x.getExtAIAInfo(hCert) →
|
|
598
|
+
* { ocsp: ["http://ocsp.foo.com"],
|
|
599
|
+
* caissuer: ["http://rep.foo.com/aaa.p8m"] }
|
|
600
|
+
*/
|
|
601
|
+
getExtAIAInfo(): {
|
|
602
|
+
caissuer: string[];
|
|
603
|
+
ocsp: string[];
|
|
604
|
+
} | undefined;
|
|
605
|
+
/**
|
|
606
|
+
* get CertificatePolicies extension value in the certificate as array
|
|
607
|
+
* @return array of PolicyInformation JSON object
|
|
608
|
+
* @description
|
|
609
|
+
* This method will get certificate policies value
|
|
610
|
+
* as an array of JSON object which has following properties:
|
|
611
|
+
*
|
|
612
|
+
* - id -
|
|
613
|
+
* - cps - URI of certification practice statement
|
|
614
|
+
* - unotice - string of UserNotice explicitText
|
|
615
|
+
*
|
|
616
|
+
* If there is this extension in the certificate,
|
|
617
|
+
* it returns undefined;
|
|
618
|
+
* @example
|
|
619
|
+
* x = new X509();
|
|
620
|
+
* x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
|
|
621
|
+
* x.getExtCertificatePolicies →
|
|
622
|
+
* [{ id: 1.2.3.4,
|
|
623
|
+
* cps: "http://example.com/cps",
|
|
624
|
+
* unotice: "explicit text" }]
|
|
625
|
+
*/
|
|
626
|
+
getExtCertificatePolicies(): {
|
|
627
|
+
cps: string;
|
|
628
|
+
id: string;
|
|
629
|
+
unotice: string;
|
|
630
|
+
} | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* read PEM formatted X.509 certificate from string.
|
|
633
|
+
* @param sCertPEM string for PEM formatted X.509 certificate
|
|
634
|
+
* @example
|
|
635
|
+
* x = new X509();
|
|
636
|
+
* x.readCertPEM(sCertPEM); // read certificate
|
|
637
|
+
*/
|
|
638
|
+
readCertPEM(sCertPEM: string): void;
|
|
639
|
+
/**
|
|
640
|
+
* read a hexadecimal string of X.509 certificate
|
|
641
|
+
* @param sCertHex hexadecimal string of X.509 certificate
|
|
642
|
+
* @description
|
|
643
|
+
* NOTE: `X509#parseExt` will be called internally since jsrsasign 7.2.0.
|
|
644
|
+
* @example
|
|
645
|
+
* x = new X509();
|
|
646
|
+
* x.readCertHex("3082..."); // read certificate
|
|
647
|
+
*/
|
|
648
|
+
readCertHex(sCertHex: string): void;
|
|
649
|
+
/**
|
|
650
|
+
* get certificate information as string.
|
|
651
|
+
* @return certificate information string
|
|
652
|
+
* @example
|
|
653
|
+
* x = new X509();
|
|
654
|
+
* x.readCertPEM(certPEM);
|
|
655
|
+
* console.log(x.getInfo());
|
|
656
|
+
* // this shows as following
|
|
657
|
+
* Basic Fields
|
|
658
|
+
* serial number: 02ac5c266a0b409b8f0b79f2ae462577
|
|
659
|
+
* signature algorithm: SHA1withRSA
|
|
660
|
+
* issuer: /C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert High Assurance EV Root CA
|
|
661
|
+
* notBefore: 061110000000Z
|
|
662
|
+
* notAfter: 311110000000Z
|
|
663
|
+
* subject: /C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert High Assurance EV Root CA
|
|
664
|
+
* subject public key info:
|
|
665
|
+
* key algorithm: RSA
|
|
666
|
+
* n=c6cce573e6fbd4bb...
|
|
667
|
+
* e=10001
|
|
668
|
+
* X509v3 Extensions:
|
|
669
|
+
* keyUsage CRITICAL:
|
|
670
|
+
* digitalSignature,keyCertSign,cRLSign
|
|
671
|
+
* basicConstraints CRITICAL:
|
|
672
|
+
* cA=true
|
|
673
|
+
* subjectKeyIdentifier :
|
|
674
|
+
* b13ec36903f8bf4701d498261a0802ef63642bc3
|
|
675
|
+
* authorityKeyIdentifier :
|
|
676
|
+
* kid=b13ec36903f8bf4701d498261a0802ef63642bc3
|
|
677
|
+
* signature algorithm: SHA1withRSA
|
|
678
|
+
* signature: 1c1a0697dcd79c9f...
|
|
679
|
+
*/
|
|
680
|
+
getInfo(): string;
|
|
681
|
+
/**
|
|
682
|
+
* get distinguished name string in OpenSSL online format from hexadecimal string of ASN.1 DER X.500 name
|
|
683
|
+
* @param hex hexadecimal string of ASN.1 DER distinguished name
|
|
684
|
+
* @param idx index of hexadecimal string (DEFAULT=0)
|
|
685
|
+
* @return OpenSSL online format distinguished name
|
|
686
|
+
* @description
|
|
687
|
+
* This static method converts from a hexadecimal string of
|
|
688
|
+
* distinguished name (DN)
|
|
689
|
+
* specified by 'hex' and 'idx' to OpenSSL oneline string representation (ex. /C=US/O=a).
|
|
690
|
+
* @example
|
|
691
|
+
* X509.hex2dn("3031310b3...") → /C=US/O=a/CN=b2+OU=b1
|
|
692
|
+
*/
|
|
693
|
+
static hex2dn(hex: string, idx: number): string;
|
|
694
|
+
/**
|
|
695
|
+
* get relative distinguished name string in OpenSSL online format from hexadecimal string of ASN.1 DER RDN
|
|
696
|
+
* @param hex hexadecimal string of ASN.1 DER concludes relative distinguished name
|
|
697
|
+
* @param idx index of hexadecimal string (DEFAULT=0)
|
|
698
|
+
* @return OpenSSL online format relative distinguished name
|
|
699
|
+
* @description
|
|
700
|
+
* This static method converts from a hexadecimal string of
|
|
701
|
+
* relative distinguished name (RDN)
|
|
702
|
+
* specified by 'hex' and 'idx' to LDAP string representation (ex. O=test+CN=test).
|
|
703
|
+
* NOTE: Multi-valued RDN is supported since jsnrsasign 6.2.2 x509 1.1.10.
|
|
704
|
+
* @example
|
|
705
|
+
* X509.hex2rdn("310a3008060355040a0c0161") → O=a
|
|
706
|
+
* X509.hex2rdn("31143008060355040a0c01613008060355040a0c0162") → O=a+O=b
|
|
707
|
+
*/
|
|
708
|
+
static hex2rdn(hex: string, idx: number): string;
|
|
709
|
+
/**
|
|
710
|
+
* get string from hexadecimal string of ASN.1 DER AttributeTypeAndValue
|
|
711
|
+
* @param hex hexadecimal string of ASN.1 DER concludes AttributeTypeAndValue
|
|
712
|
+
* @param idx index of hexadecimal string (DEFAULT=0)
|
|
713
|
+
* @return string representation of AttributeTypeAndValue (ex. C=US)
|
|
714
|
+
* @description
|
|
715
|
+
* This static method converts from a hexadecimal string of AttributeTypeAndValue
|
|
716
|
+
* specified by 'hex' and 'idx' to LDAP string representation (ex. C=US).
|
|
717
|
+
* @example
|
|
718
|
+
* X509.hex2attrTypeValue("3008060355040a0c0161") → O=a
|
|
719
|
+
* X509.hex2attrTypeValue("300806035504060c0161") → C=a
|
|
720
|
+
* X509.hex2attrTypeValue("...3008060355040a0c0161...", 128) → O=a
|
|
721
|
+
*/
|
|
722
|
+
static hex2attrTypeValue(hex: string, idx: number): string;
|
|
723
|
+
/**
|
|
724
|
+
* get RSA/DSA/ECDSA public key object from X.509 certificate hexadecimal string
|
|
725
|
+
* @param h hexadecimal string of X.509 certificate for RSA/ECDSA/DSA public key
|
|
726
|
+
* @return returns RSAKey/KJUR.crypto.{ECDSA,DSA} object of public key
|
|
727
|
+
*/
|
|
728
|
+
static getPublicKeyFromCertHex(h: string): RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA;
|
|
729
|
+
/**
|
|
730
|
+
* get RSA/DSA/ECDSA public key object from PEM certificate string
|
|
731
|
+
* @param sCertPEM PEM formatted RSA/ECDSA/DSA X.509 certificate
|
|
732
|
+
* @return returns RSAKey/KJUR.crypto.{ECDSA,DSA} object of public key
|
|
733
|
+
* @description
|
|
734
|
+
* NOTE: DSA is also supported since x509 1.1.2.
|
|
735
|
+
*/
|
|
736
|
+
static getPublicKeyFromCertPEM(sCertPEM: string): RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA;
|
|
737
|
+
/**
|
|
738
|
+
* get public key information from PEM certificate
|
|
739
|
+
* @param sCertPEM string of PEM formatted certificate
|
|
740
|
+
* @return hash of information for public key
|
|
741
|
+
* @description
|
|
742
|
+
* Resulted associative array has following properties:
|
|
743
|
+
*
|
|
744
|
+
* - algoid - hexadecimal string of OID of asymmetric key algorithm
|
|
745
|
+
* - algparam - hexadecimal string of OID of ECC curve name or null
|
|
746
|
+
* - keyhex - hexadecimal string of key in the certificate
|
|
747
|
+
*
|
|
748
|
+
* NOTE: X509v1 certificate is also supported since x509.js 1.1.9.
|
|
749
|
+
*/
|
|
750
|
+
static getPublicKeyInfoPropOfCertPEM(sCertPEM: string): PublicKeyInfoPropOfCertPEMResult;
|
|
751
|
+
}
|
|
752
|
+
declare function sha256(message: string): string;
|
|
753
|
+
export { X509, RSAKey, sha256, pemtohex, hextopem, b64tohex, hex2b64 };
|