软航科技NTKO安全签名印章系统WEB版本编程手册.doc

《软航科技NTKO安全签名印章系统WEB版本编程手册.doc》由会员分享，可在线阅读，更多相关《软航科技NTKO安全签名印章系统WEB版本编程手册.doc（27页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、软航科技NTKO安全签名印章系统WEB版编程手册NTKO安全签章系统WEB版编程手册Web：http:/Email：,版本：适应3.0.9.2及以上版本。更新日期：2010.05.26Copyright：本文档及技术资料版权所有，未经书面许可，禁止拷贝分发。重庆软航科技有限公司电子邮件：SALEINFONTKO.COMWEB：HTTP:/WWW.NTKO.COM/TEL：023-62943208 FAX：023-62943208-802 COPYRIGHT 2003-2010，BY NTKO SOFTWAREALL RIGHTS RESERVED版权所有：软航科技保留所有权利未经许可,请勿分发

2、本文档的部分或全部WEB:HTTP:/WWW.NTKO.COMTEL:023-62943208EMAIL:SUPPORTNTKO.COMFAX:023-62943208-802重庆软航科技有限公司目 录第1章 NTKO安全签章系统WEB版体系介绍1第2章 Helper 控件CLSID及基本示例：1第3章 网页中必须包含的js文件2第4章 Helper 控件的主要属性介绍54.1、 状态代码和控件外观51、 StatusCode52、 StatusMessage53、 BackColor, ForeColor54.2、 网络传输相关属性51、 IsUseControlAgent52、 IsUse

3、UTF8URL63、 IsUseUTF8Data64、 IsDirectConnect64.3、 签章相关属性61、 SignsCount62、 IsEkeyConnected63、 EkeySN6第5章 Helper 控件的主要方法介绍：61、 AddSecSignOcx在网页中创建新的签章对象62、 AddSecHandSign在网页中进行手写签名73、 AddSecKeyBoardComment在网页添加键盘批注84、 AddSecSignFromLocal从本地文件系统进行签章85、 AddSecSignFromURL从服务器URL进行签章106、 AddSecSignFromEkey

4、从EKEY硬件进行签章117、 SaveToURL将所有签章数据保存到URL118、 LoadFromURL从服务器URL装载签章数据139、 DoWebExecute2执行WEB调用13第6章 签章控件的属性参考141、 WebSignInfo142、 Signer153、 SignUser154、 SignName155、 SignTime156、 SignSource157、 SignSN158、 EkeySN159、 SignComment1510、 HandSignPenColor1511、 HandSignPenWidth1612、 HandSignPenStyle1613、 Po

5、sitionTagId1614、 IsShowTimeForceStyle1715、 SignTimeShowStyle1816、 IsShowTimeForcePos1817、 SignTimeShowPos1818、 IsShowCommentForcePos1819、 SignCommentShowPos1920、 SignTimeDefaultColor1921、 SignCommentDefaultColor1922、 IsPermitUserSelTime1923、 HandSignScale2024、 IsShowKeyBoardCommentBorder2025、 Defaul

6、tSignComment2026、 SignCommentFontName2027、 SignCommentFontSize2028、 UserData20第7章 签章控件的方法参考201、 SetPrintMode设定印章打印模式202、 ReSetHTMLPosition方法20第8章 签章控件的事件参考211、 盖章之前事件212、 EKEY盖章之前事件213、 印章删除之后的事件224、 用户自定义检查权限事件22第9章 编程简要说明24第1章 NTKO安全签章系统WEB版体系介绍NTKO安全签名印章系统WEB版本由两部分组成：u NTKO安全签名印章系统Helper控件（NTKO W

7、ebSignHelper 控件）；u NTKO安全签名印章系统签章控件Helper控件负责在网页上创建签章控件，并调用签章控件的方法实现签章。后者是签章的实现控件。另外，Helper控件还负责将网页上已经存在的签章控件的数据保存到WEB服务器，以及从WEB服务器装载所有的签章数据，并在网页上恢复所有签章。您在编程中直接使用到的一般是NTKO安全签名印章系统Helper控件（NTKO WebSignHelper 控件）的属性和方法，以及签章控件的WebSignInfo属性。第2章 Helper 控件CLSID及基本示例：不能装载NTKO WebSignHelper 控件。请在检查浏览器的选项中检

8、查浏览器的安全设置。% 注意：在windows新版本的IE中，为了避免IE产生“按空格键或Enter键以激活并使用此控件”的提示，需要在网页中引入一个js文件，在js文件中通过document.write动态产生上述代码。比如：网页中的代码如下：% 和网页在同一目录的NtkoGenObj.js文件的代码如下：注意js的编码方式必须和网页的编码方式一致document.write( );document.write( );document.write( );document.write( );document.write( );document.write(不能装载NTKO WebSignHel

9、per 控件。请在检查浏览器的选项中检查浏览器的安全设置。 );document.write( );第3章 网页中必须包含的js文件因为NTKO安全签名印章系统WEB版本需要调用一个js文件中的固定名称的JavaScript Function来创建印章并完成签章工作，因此，需要在网页的和标记之间，使用：来引入一个系统所需的NtkoAddSecSign .js文件。这个文件您最好不进行任何修改。除了必须的时候修改编码方式。% 和网页在同一目录的NtkoAddSecSign .js文件的内容如下：注意js的编码方式必须和网页的编码方式一致，请参考相关示例目录下的NtkoAddSecSign .js

10、文件 /注意:这是内部需要使用的函数，除/ocxElement.codebase = ntkoWebSign.cab#version=3,0,9,2;/语句可以根据需要修改之外，其他语句不要修改function NtkoReserved_AddSecSignOcx(ControlID,ocxLeft,ocxTop)var ocxElement = null;tryocxElement = document.createElement(object);if(string = typeof(ControlID)ocxElement.id = ControlID;ocxElement.style.p

11、osition = absolute;ocxElement.style.pixelLeft = ocxLeft;ocxElement.style.pixelTop = ocxTop;ocxElement.codebase = ntkoWebSign.cab#version=3,0,9,2;ocxElement.classid = clsid:AA4B3728-B61C-4bcc-AEE7-0AA47D3C0DDA; ocxElement.width = 10;ocxElement.height = 10;document.body.appendChild(ocxElement);return

12、ocxElement;catch(err)alert(印章对象装载错误!请确认您正确安装了NTKO安全电子印章系统！+ err.number + : + err.description);if(ocxElement)ocxElement.removeNode();return null;/注意：以下函数除提示信息之外，其他语句不要修改。function NtkoReserved_RunSignHelper(ocxElement,UserName,FileName,PromptSelect,PrintMode,IsUseCertificate,IsLocked,IsCheckDocChange,

13、IsShowUI,SignPass,SignType,IsAddComment,AdjustToHeight,SignIndex)if(object != typeof(ocxElement) return;ocxElement.SetUser(UserName);switch(SignType)case 0:tryocxElement.DoSign(FileName,PromptSelect, SignPass, PrintMode, IsUseCertificate, IsLocked,IsCheckDocChange,IsShowUI,IsAddComment);catch(err)al

14、ert(加盖印章错误!);ocxElement.Close();ocxElement.removeNode();break;case 1:tryocxElement.DoHandSign(PrintMode,IsUseCertificate,IsLocked,IsCheckDocChange,IsShowUI,SignPass,IsAddComment,AdjustToHeight);catch(err)alert(手写签名错误!);ocxElement.Close();ocxElement.removeNode();break;case 2:tryocxElement.DoSignFromE

15、key(SignPass,PrintMode,IsUseCertificate,IsLocked,IsCheckDocChange,IsShowUI,SignIndex,IsAddComment);catch(err)alert(加盖EKEY印章错误!);ocxElement.Close();ocxElement.removeNode();break;case 3:tryocxElement.DoKeyBoardComment(PrintMode,IsUseCertificate,IsLocked,IsCheckDocChange,IsShowUI,SignPass);catch(err)al

16、ert(添加安全键盘批注错误!);ocxElement.Close();ocxElement.removeNode();break;default: tryocxElement.DoSign(FileName,true, SignPass, PrintMode, IsUseCertificate, IsLocked,IsCheckDocChange,IsShowUI);catch(err)alert(加盖印章错误!);ocxElement.Close();ocxElement.removeNode();break;第4章 Helper 控件的主要属性介绍4.1、 状态代码和控件外观1、 Sta

17、tusCodeStatusCode 最后的操作代码。只读。如果为0，表示最后的操作（方法调用）成功。2、 StatusMessageStatusMessage最后的操作状态字符串。可读写。如果给这个属性赋值，则标识在Helper控件中显示信息。3、 BackColor, ForeColorBackColor 读取/设置控件的背景色ForeColor 读取/设置控件的前景色文本颜色.4.2、 网络传输相关属性1、 IsUseControlAgentIsUseControlAgent：读取/设置向服务器提交请求时是否使用NTKO OFFICE CONTROL AGENT.此信息也可用于判断是否是控

18、件请求的数据.从而可以设定后台程序拒绝其他请求。2、 IsUseUTF8URLIsUseUTF8URL：读取/设置是否使用UTF-8传输URL。3、 IsUseUTF8DataIsUseUTF8Data：读取/设置是否使用UTF-8在智能提交中传输网页数据。如果网页编码设置为UTF-8，需要设置此属性，以便控件自动使用UTF-8编码进行网页数据的提交。4、 IsDirectConnectIsDirectConnect：读取/设置是否使用直接连接服务器。【而不是默认的采用浏览器设置】。对于某些老版本的代理服务器环境，设置此选项可以避免因浏览器自动检测代理服务器引起的问题。4.3、 签章相关属性1

19、、 SignsCountSignsCount：只读。读取当前网页中的当前签章数量。2、 IsEkeyConnectedIsEkeyConnected：只读。布尔型。判别NTKO EKEY是否已经连接到计算机。如果已连接返回true，否则返回false。3、 EkeySNEkeySN：只读，字符串，获取系统连接的EKEY的序列号。如果没有EKEY连接到系统，返回空值。第5章 Helper 控件的主要方法介绍：1、 AddSecSignOcx在网页中创建新的签章对象AddSecSignOcx(in,optional VARIANT ControlID,in,optional VARIANT lef

20、t,in,optional VARIANT top);返回值：如果成功，返回新创建的签章对象。您后续可以设定签章对象的WEB认证域信息，并对该签章对象运行后面描述的签章相关的方法。参数说明：ControlID：可选参数。要创建的签章对象的ID，字符串。Left：可选参数。整数。新签章在网页中的左边位置相对网页左上角。默认值是100；top：可选参数。整数。新签章在网页中的上边位置相对网页左上角。默认值是100；2、 AddSecHandSign在网页中进行手写签名AddSecHandSign(in secSignOnj,in BSTR username,in,optional VARIANT

21、PrintMode,in,optional VARIANT IsUseCertificate,in,optional VARIANT IsLocked,in,optional VARIANT IsCheckDocChange,in,optional VARIANT IsShowUI,in,optional VARIANT signpass,in,optional VARIANT IsAddComment,in,optional VARIANT AdjustToHeight);参数说明：secSignOnj：必须的参数，必须是AddSecSignOcx方法返回的签章对象。username：字符串

22、。必须的参数。标识签章用户；PrintMode：整数0-2，签章的打印属性。0=不打印，1=打印灰色，2=打印原始。默认值是0.IsUseCertificate：布尔型，true 或者false。可选参数。指明签章时是否使用数字证书。默认值是false。IsLocked：布尔型，true 或者false。可选参数。指明签章时是否锁定印章，默认值是false。IsCheckDocChange：布尔型，true 或者false。可选参数。指明签章是否检查文档改变，默认值是true。IsShowUI：布尔型，true 或者false。可选参数。指明签章时是否显示以上签章设定对话框选项，默认值是tru

23、e。Signpass：字符串。可选参数。指明键盘批注的口令。如果指明了此参数，将不提示用户输入保护手写签名的口令。IsAddComment：布尔型，true 或者false。可选参数。指明签章时是否允许用户输入批注。默认值是true。AdjustToHeight：整数型。默认参数0，可选参数。指定手写签名后，自动缩放签名图片到指定高度。宽度和高度同比例缩放。3、 AddSecKeyBoardComment在网页添加键盘批注AddSecKeyBoardComment (in secSignOnj,in BSTR username,in,optional VARIANT PrintMode,in,

24、optional VARIANT IsUseCertificate,in,optional VARIANT IsLocked,in,optional VARIANT IsCheckDocChange,in,optional VARIANT IsShowUI,in,optional VARIANT signpass);参数说明：secSignOnj：必须的参数，必须是AddSecSignOcx方法返回的签章对象。username：字符串。必须的参数。标识签章用户；PrintMode：整数0-2，签章的打印属性。0=不打印，1=打印灰色，2=打印原始。默认值是0.IsUseCertificate：

25、布尔型，true 或者false。可选参数。指明签章时是否使用数字证书。默认值是false。IsLocked：布尔型，true 或者false。可选参数。指明签章时是否锁定印章，默认值是false。IsCheckDocChange：布尔型，true 或者false。可选参数。指明签章是否检查文档改变，默认值是true。IsShowUI：布尔型，true 或者false。可选参数。指明签章时是否显示以上签章设定对话框选项，默认值是true。Signpass：字符串。可选参数。指明键盘批注的口令。如果指明了此参数，将不提示用户输入保护批注的口令。4、 AddSecSignFromLocal从本地文

26、件系统进行签章AddSecSignFromLocal(in secSignOnj,in BSTR username, in BSTR Filename,in,optional VARIANT PromptSelect,in,optional VARIANT PrintMode,in,optional VARIANT IsUseCertificate,in,optional VARIANT IsLocked,in,optional VARIANT IsCheckDocChange,in,optional VARIANT IsShowUI,in,optional VARIANT signpass,

27、in,optional VARIANT IsAddComment)参数说明：secSignOnj：必须的参数，必须是AddSecSignOcx方法返回的签章对象。username：字符串。必须的参数。标识签章用户；Filename：字符串。必须的参数。标识本地签章文件的路径。如果下面的参数是true，或者此参数为空字符串或者null，则提示用户选择一个签章文件。PromptSelect：布尔型，true 或者false。可选参数。指明签章时是否提示用户选择本地的签章文件。默认值是true。PrintMode：整数0-2，签章的打印属性。0=不打印，1=打印灰色，2=打印原始。默认值是0.IsU

28、seCertificate：布尔型，true 或者false。可选参数。指明签章时是否使用数字证书。默认值是false。IsLocked：布尔型，true 或者false。可选参数。指明签章时是否锁定印章，默认值是false。IsCheckDocChange：布尔型，true 或者false。可选参数。指明签章是否检查文档改变，默认值是true。IsShowUI：布尔型，true 或者false。可选参数。指明签章时是否显示以上签章设定对话框选项，默认值是true。Signpass：字符串。可选参数。指明签章文件的口令。如果指明了此参数，且口令正确，将不提示用户输入签章的口令。IsAddCom

29、ment：布尔型，true 或者false。可选参数。指明签章时是否允许用户输入批注。默认值是true。5、 AddSecSignFromURL从服务器URL进行签章AddSecSignFromURL(in secSignOnj,in BSTR username,in BSTR URL,in,optional VARIANT PrintMode,in,optional VARIANT IsUseCertificate,in,optional VARIANT IsLocked,in,optional VARIANT IsCheckDocChange,in,optional VARIANT IsS

30、howUI,in,optional VARIANT signpass,in,optional VARIANT IsAddComment);参数说明：secSignOnj：必须的参数，必须是AddSecSignOcx方法返回的签章对象。username：字符串。必须的参数。标识签章用户；URL：字符串。必须的参数。标识服务器上签章文件的URL。这个URL可以直接指向服务器上的一个实际文件，也可以是一个服务器后台的动态文件，只要这个URL能够返回签章文件的实际二进制数据流即可。PrintMode：整数0-2，签章的打印属性。0=不打印，1=打印灰色，2=打印原始。默认值是0.IsUseCertif

31、icate：布尔型，true 或者false。可选参数。指明签章时是否使用数字证书。默认值是false。IsLocked：布尔型，true 或者false。可选参数。指明签章时是否锁定印章，默认值是false。IsCheckDocChange：布尔型，true 或者false。可选参数。指明签章是否检查文档改变，默认值是true。IsShowUI：布尔型，true 或者false。可选参数。指明签章时是否显示以上签章设定对话框选项，默认值是true。Signpass：字符串。可选参数。指明签章文件的口令。如果指明了此参数，且口令正确，将不提示用户输入签章的口令。IsAddComment：布尔型

32、，true 或者false。可选参数。指明签章时是否允许用户输入批注。默认值是true。6、 AddSecSignFromEkey从EKEY硬件进行签章AddSecSignFromEkey(in secSignOnj,in BSTR username,in,optional VARIANT PrintMode,in,optional VARIANT IsUseCertificate,in,optional VARIANT IsLocked,in,optional VARIANT IsCheckDocChange,in,optional VARIANT IsShowUI,in,optional

33、VARIANT signpass,in,optional VARIANT IsAddComment,in,optional VARIANT SignIndex)参数说明：secSignOnj：必须的参数，必须是AddSecSignOcx方法返回的签章对象。username：字符串。必须的参数。标识签章用户；PrintMode：整数0-2，签章的打印属性。0=不打印，1=打印灰色，2=打印原始。默认值是0.IsUseCertificate：布尔型，true 或者false。可选参数。指明签章时是否使用数字证书。默认值是false。IsLocked：布尔型，true 或者false。可选参数。指明

34、签章时是否锁定印章，默认值是false。IsCheckDocChange：布尔型，true 或者false。可选参数。指明签章是否检查文档改变，默认值是true。IsShowUI：布尔型，true 或者false。可选参数。指明签章时是否显示以上签章设定对话框选项，默认值是true。Signpass：字符串。可选参数。指明签章文件的口令。如果指明了此参数，且口令正确，将不提示用户输入签章的口令。IsAddComment：布尔型，true 或者false。可选参数。指明签章时是否允许用户输入批注。默认值是true。SignIndex：整形。-1,0-9。EKEY中的印章位置号。如果传入-1或者省

35、略该参数，则提示用户选择EKEY中的印章位置。7、 SaveToURL将所有签章数据保存到URL% 此方法和NTKO OFFICE文档控件的savetourl参数和返回值的含义都相同。SaveToURL(in VARIANT URL,in VARIANT FileFieldName,in,optional VARIANT CPARA,in,optional VARIANT FileName,in,optional VARIANT HTMLForm)该方法使用HTTP协议将文件保存到URL。参数说明：URL可以是相对于控件所在的网页的相对URL或者是绝对URL。FileFieldName相当于一

36、个HTML页面的Form中的中的FileFieldName。可选参数CPARA是可以让用户定义没有在表单中出现的参数。该参数是以”&”分隔的参数值对。一个可能的CPARA值为：”key=thiskey&type=word&load=mywave”。% $注意：对于CPARA参数，因为控件接受以”&”分隔的参数值对，所以，如果在值中，有”&”符号出现，应该替换成”%26”；相应的，所以如果在参数的值中有”%”符号出现，应该替换成”%25”。比如下面的代码将一个值中所有的”%”符号和”&”符号进行替换，并返回替换后的字符串：function encodeObjValue(value)var t;t

37、 = value.replace(/%/g,%25);return(t.replace(/&/g,%26);可选参数FileName被用来直接指明文件名。可选参数HTMLForm用来指定随控件中的文档一起提交的HTML FORM。可以使用FORM的ID，比如，“myForm”来指定，或者，也可以使用FORM在网页中所有FORM中的序号，比如，0，来指定。该方法返回值是提交URL之后从服务器返回的数据。为了使该方法工作，必须在Web服务器中开发一个能够处理表单提交的CGI或者ASP或者是JSP等程序。比如，对于如下表单：type:workflow:select file:  

38、  SaveToURL(“/postCGI.jsp”,”SIGNSFILE”,”,”ntkowebsigns.info”,”myForm”)或：SaveToURL(“/postCGI.jsp”,”SIGNSFILE”,”,”ntkowebsigns.info”,0)都会在将正在编辑的文档作为一个上传文件的同时，提交上述表单中的所有数据。因此，postCGI.jsp程序中，除了处理上述表单的数据，还应该处理一个名称为SIGNSFILE，文件名为ntkowebsigns.info的上传文件。8、 LoadFromURL从服务器URL装载签章数据LoadFromURL (in V

39、ARIANT URL)该方法唯一的而且是必须的参数是签章数据文件的URL。这个数据文件应该是由SaveToURL方法保存到服务器上的。这个URL可以直接指向服务器上的一个实际的标识签章数据的文件，也可以是一个服务器后台的动态文件，只要这个URL能够返回所有的签章数据的实际二进制数据流即可。9、 DoWebExecute2执行WEB调用DoWebExecute2(URL, CPARA)该方法向WEB服务器URL提交一个POST请求并获得返回值。该方法可以用来在盖章事件中向服务器查询印章状态。具体请参考本文档第8章，签章控件的事件参考。该方法返回值是提交URL之后从服务器返回的数据。URL是提交请

40、求的URL。字符串。可以是相对于控件所在的网页的相对URL或者是绝对URL。参数CPARA是可以让用户传递的参数。该参数是以”&”分隔的参数值对。一个可能的CPARA值为：”key=thiskey&type=word&load=mywave”。% $注意：对于CPARA参数，因为控件接受以”&”分隔的参数值对，所以，如果在值中，有”&”符号出现，应该替换成”%26”；相应的，所以如果在参数的值中有”%”符号出现，应该替换成”%25”。在URL处理页面中，可用用获取表单值的方式获取CPARA参数中传递的参数值。比如，对于如下js调用：var retValue = HelperOcx.DoWebExecute2(“/checksign.asp”,UserName=UserNameValue&SignName=SignNameValue&SignUser=SignUserValue&SignSN=SignSNValue”);对于服务器上的如下checksign.asp文件：% L