46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.security.cert.d.ts 236.13 KB
一键复制 编辑 原始数据 按行查看 历史
lichaochen 提交于 28天前 . 可选参数增加[]
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636
/*
* Copyright (c) 2022-2025 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit DeviceCertificateKit
*/
import type { AsyncCallback } from './@ohos.base';
import cryptoFramework from './@ohos.security.cryptoFramework';
/**
* Provides a series of capabilities related to certificates,
* which supports parsing, verification, and output of certificates, extensions, and CRLs.
*
* @namespace cert
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides a series of capabilities related to certificates,
* which supports parsing, verification, and output of certificates, extensions, and CRLs.
*
* @namespace cert
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides a series of capabilities related to certificates,
* which supports parsing, verification, and output of certificates, extensions, and CRLs.
*
* @namespace cert
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace cert {
/**
* Enum for result code
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Enum for result code
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Enum for result code
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum CertResult {
/**
* Indicates that input parameters is invalid.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that input parameters is invalid.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates that input parameters is invalid.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
INVALID_PARAMS = 401,
/**
* Indicates that function or algorithm is not supported.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that function or algorithm is not supported.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates that function or algorithm is not supported.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
NOT_SUPPORT = 801,
/**
* Indicates the memory malloc failed.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the memory malloc failed.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates the memory malloc failed.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_OUT_OF_MEMORY = 19020001,
/**
* Indicates that runtime error.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that runtime error.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates that runtime error.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_RUNTIME_ERROR = 19020002,
/**
* Indicates that parameter check failed.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
ERR_PARAMETER_CHECK_FAILED = 19020003,
/**
* Indicates the crypto operation error.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the crypto operation error.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates the crypto operation error.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_CRYPTO_OPERATION = 19030001,
/**
* Indicates that the certificate signature verification failed.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that the certificate signature verification failed.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates that the certificate signature verification failed.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_CERT_SIGNATURE_FAILURE = 19030002,
/**
* Indicates that the certificate has not taken effect.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that the certificate has not taken effect.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates that the certificate has not taken effect.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_CERT_NOT_YET_VALID = 19030003,
/**
* Indicates that the certificate has expired.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates that the certificate has expired.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates that the certificate has expired.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_CERT_HAS_EXPIRED = 19030004,
/**
* Indicates a failure to obtain the certificate issuer.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates a failure to obtain the certificate issuer.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates a failure to obtain the certificate issuer.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY = 19030005,
/**
* The key cannot be used for signing a certificate.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The key cannot be used for signing a certificate.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The key cannot be used for signing a certificate.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_KEYUSAGE_NO_CERTSIGN = 19030006,
/**
* The key cannot be used for digital signature.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The key cannot be used for digital signature.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The key cannot be used for digital signature.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE = 19030007,
/**
* The password may be wrong.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
ERR_MAYBE_WRONG_PASSWORD = 19030008
}
/**
* Provides the data blob type.
*
* @typedef DataBlob
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the data blob type.
*
* @typedef DataBlob
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides the data blob type.
*
* @typedef DataBlob
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataBlob {
/**
* Indicates the content of data blob.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the content of data blob.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates the content of data blob.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
data: Uint8Array;
}
/**
* Provides the data array type.
*
* @typedef DataArray
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the data array type.
*
* @typedef DataArray
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides the data array type.
*
* @typedef DataArray
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface DataArray {
/**
* Indicates the content of data array.
*
* @type { Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Indicates the content of data array.
*
* @type { Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates the content of data array.
*
* @type { Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
data: Array<Uint8Array>;
}
/**
* Enum for supported cert encoding format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Enum for supported cert encoding format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Enum for supported cert encoding format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum EncodingFormat {
/**
* The value of cert DER format.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The value of cert DER format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The value of cert DER format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
FORMAT_DER = 0,
/**
* The value of cert PEM format.
*
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The value of cert PEM format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The value of cert PEM format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
FORMAT_PEM = 1,
/**
* The value of cert chain PKCS7 format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The value of cert chain PKCS7 format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
FORMAT_PKCS7 = 2
}
/**
* Enum for the certificate item type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Enum for the certificate item type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Enum for the certificate item type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum CertItemType {
/**
* Indicates to get certificate TBS(to be signed) value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate TBS(to be signed) value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get certificate TBS(to be signed) value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CERT_ITEM_TYPE_TBS = 0,
/**
* Indicates to get certificate public key.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate public key.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get certificate public key.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CERT_ITEM_TYPE_PUBLIC_KEY = 1,
/**
* Indicates to get certificate issuer unique id value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate issuer unique id value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get certificate issuer unique id value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CERT_ITEM_TYPE_ISSUER_UNIQUE_ID = 2,
/**
* Indicates to get certificate subject unique id value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate subject unique id value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get certificate subject unique id value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CERT_ITEM_TYPE_SUBJECT_UNIQUE_ID = 3,
/**
* Indicates to get certificate extensions value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get certificate extensions value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get certificate extensions value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CERT_ITEM_TYPE_EXTENSIONS = 4
}
/**
* Enumerates for the certificate extension object identifier (OID) types.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Enumerates for the certificate extension object identifier (OID) types.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Enumerates for the certificate extension object identifier (OID) types.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum ExtensionOidType {
/**
* Indicates to obtain all types of OIDs, including critical and uncritical types.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to obtain all types of OIDs, including critical and uncritical types.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to obtain all types of OIDs, including critical and uncritical types.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
EXTENSION_OID_TYPE_ALL = 0,
/**
* Indicates to obtain OIDs of the critical type.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to obtain OIDs of the critical type.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to obtain OIDs of the critical type.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
EXTENSION_OID_TYPE_CRITICAL = 1,
/**
* Indicates to obtain OIDs of the uncritical type.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to obtain OIDs of the uncritical type.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to obtain OIDs of the uncritical type.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
EXTENSION_OID_TYPE_UNCRITICAL = 2
}
/**
* Enum for the certificate extension entry type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Enum for the certificate extension entry type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Enum for the certificate extension entry type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum ExtensionEntryType {
/**
* Indicates to get extension entry.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get extension entry.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get extension entry.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
EXTENSION_ENTRY_TYPE_ENTRY = 0,
/**
* Indicates to get extension entry critical.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get extension entry critical.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get extension entry critical.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
EXTENSION_ENTRY_TYPE_ENTRY_CRITICAL = 1,
/**
* Indicates to get extension entry value.
*
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Indicates to get extension entry value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Indicates to get extension entry value.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
EXTENSION_ENTRY_TYPE_ENTRY_VALUE = 2
}
/**
* Provides the cert encoding blob type.
*
* @typedef EncodingBlob
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the cert encoding blob type.
*
* @typedef EncodingBlob
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides the cert encoding blob type.
*
* @typedef EncodingBlob
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface EncodingBlob {
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
data: Uint8Array;
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
encodingFormat: EncodingFormat;
}
/**
* Provides the cert chain data type.
*
* @typedef CertChainData
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the cert chain data type.
*
* @typedef CertChainData
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides the cert chain data type.
*
* @typedef CertChainData
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertChainData {
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The data input.
*
* @type { Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
data: Uint8Array;
/**
* The number of certs.
*
* @type { number }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The number of certs.
*
* @type { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The number of certs.
*
* @type { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
count: number;
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The data encoding format.
*
* @type { EncodingFormat }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
encodingFormat: EncodingFormat;
}
/**
* Enum for Encoding type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum EncodingType {
/**
* Indicates to utf8 type.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ENCODING_UTF8 = 0
}
/**
* Provides the x509 cert type.
*
* @typedef X509Cert
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides the x509 cert type.
*
* @typedef X509Cert
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides the x509 cert type.
*
* @typedef X509Cert
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X509Cert {
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @param { AsyncCallback<void> } callback - the callback of verify.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @param { AsyncCallback<void> } callback - the callback of verify.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @param { AsyncCallback<void> } callback - the callback of verify.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
verify(key: cryptoFramework.PubKey, callback: AsyncCallback<void>): void;
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Verify the X509 cert.
*
* @param { cryptoFramework.PubKey } key - public key to verify cert.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
verify(key: cryptoFramework.PubKey): Promise<void>;
/**
* Get X509 cert encoded data.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert encoded data.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert encoded data.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Get X509 cert encoded data.
*
* @returns { Promise<EncodingBlob> } the promise of X509 cert encoded data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert encoded data.
*
* @returns { Promise<EncodingBlob> } the promise of X509 cert encoded data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert encoded data.
*
* @returns { Promise<EncodingBlob> } the promise of X509 cert encoded data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Get X509 cert public key.
*
* @returns { cryptoFramework.PubKey } X509 cert pubKey.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert public key.
*
* @returns { cryptoFramework.PubKey } X509 cert pubKey.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert public key.
*
* @returns { cryptoFramework.PubKey } X509 cert pubKey.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getPublicKey(): cryptoFramework.PubKey;
/**
* Check the X509 cert validity with date.
*
* @param { string } date - indicates the cert date.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Check the X509 cert validity with date.
*
* @param { string } date - indicates the cert date.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Check the X509 cert validity with date.
*
* @param { string } date - indicates the cert date.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
checkValidityWithDate(date: string): void;
/**
* Get X509 cert version.
*
* @returns { number } X509 cert version.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert version.
*
* @returns { number } X509 cert version.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert version.
*
* @returns { number } X509 cert version.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getVersion(): number;
/**
* Get X509 cert serial number.
*
* @returns { number } X509 cert serial number.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 10
* @useinstead ohos.security.cert.X509Cert.getCertSerialNumber
*/
getSerialNumber(): number;
/**
* Get X509 cert serial number.
*
* @returns { bigint } X509 cert serial number.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get X509 cert serial number.
*
* @returns { bigint } X509 cert serial number.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert serial number.
*
* @returns { bigint } X509 cert serial number.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getCertSerialNumber(): bigint;
/**
* Get X509 cert issuer name.
*
* @returns { DataBlob } X509 cert issuer name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert issuer name.
*
* @returns { DataBlob } X509 cert issuer name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert issuer name.
*
* @returns { DataBlob } X509 cert issuer name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getIssuerName(): DataBlob;
/**
* Get X509 cert issuer name according to the encoding type.
*
* @param { EncodingType } encodingType indicates the encoding type.
* @returns { string } X509 cert issuer name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19020003 - parameter check failed. Possible causes:
* <br>1. The value of encodingType is not in the EncodingType enumeration range.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
getIssuerName(encodingType: EncodingType): string;
/**
* Get X509 cert subject name.
*
* @returns { DataBlob } X509 cert subject name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert subject name.
*
* @returns { DataBlob } X509 cert subject name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert subject name.
*
* @param { EncodingType } [encodingType] indicates the encoding type, if the encoding type parameter is not set,
* the default ASCII encoding is used.
* @returns { DataBlob } X509 cert subject name.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Incorrect parameter types;
* <br>2. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSubjectName(encodingType?: EncodingType): DataBlob;
/**
* Get X509 cert not before time.
*
* @returns { string } X509 cert not before time.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert not before time.
*
* @returns { string } X509 cert not before time.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert not before time.
*
* @returns { string } X509 cert not before time.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getNotBeforeTime(): string;
/**
* Get X509 cert not after time.
*
* @returns { string } X509 cert not after time.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert not after time.
*
* @returns { string } X509 cert not after time.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert not after time.
*
* @returns { string } X509 cert not after time.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getNotAfterTime(): string;
/**
* Get X509 cert signature.
*
* @returns { DataBlob } X509 cert signature.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature.
*
* @returns { DataBlob } X509 cert signature.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert signature.
*
* @returns { DataBlob } X509 cert signature.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignature(): DataBlob;
/**
* Get X509 cert signature's algorithm name.
*
* @returns { string } X509 cert signature's algorithm name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature's algorithm name.
*
* @returns { string } X509 cert signature's algorithm name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert signature's algorithm name.
*
* @returns { string } X509 cert signature's algorithm name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignatureAlgName(): string;
/**
* Get X509 cert signature's algorithm oid.
*
* @returns { string } X509 cert signature's algorithm oid.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature's algorithm oid.
*
* @returns { string } X509 cert signature's algorithm oid.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert signature's algorithm oid.
*
* @returns { string } X509 cert signature's algorithm oid.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignatureAlgOid(): string;
/**
* Get X509 cert signature's algorithm name.
*
* @returns { DataBlob } X509 cert signature's algorithm name.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert signature's algorithm name.
*
* @returns { DataBlob } X509 cert signature's algorithm name.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert signature's algorithm name.
*
* @returns { DataBlob } X509 cert signature's algorithm name.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignatureAlgParams(): DataBlob;
/**
* Get X509 cert key usage.
*
* @returns { DataBlob } X509 cert key usage.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert key usage.
*
* @returns { DataBlob } X509 cert key usage.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert key usage.
*
* @returns { DataBlob } X509 cert key usage.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getKeyUsage(): DataBlob;
/**
* Get X509 cert extended key usage.
*
* @returns { DataArray } X509 cert extended key usage.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert extended key usage.
*
* @returns { DataArray } X509 cert extended key usage.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert extended key usage.
*
* @returns { DataArray } X509 cert extended key usage.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getExtKeyUsage(): DataArray;
/**
* Get X509 cert basic constraints path len.
*
* @returns { number } X509 cert basic constraints path len.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert basic constraints path len.
*
* @returns { number } X509 cert basic constraints path len.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert basic constraints path len.
*
* @returns { number } X509 cert basic constraints path len.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getBasicConstraints(): number;
/**
* Get X509 cert subject alternative name.
*
* @returns { DataArray } X509 cert subject alternative name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert subject alternative name.
*
* @returns { DataArray } X509 cert subject alternative name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert subject alternative name.
*
* @returns { DataArray } X509 cert subject alternative name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSubjectAltNames(): DataArray;
/**
* Get X509 cert issuer alternative name.
*
* @returns { DataArray } X509 cert issuer alternative name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Get X509 cert issuer alternative name.
*
* @returns { DataArray } X509 cert issuer alternative name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get X509 cert issuer alternative name.
*
* @returns { DataArray } X509 cert issuer alternative name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getIssuerAltNames(): DataArray;
/**
* Get certificate item value.
*
* @param { CertItemType } itemType
* @returns { DataBlob } cert item value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate item value.
*
* @param { CertItemType } itemType
* @returns { DataBlob } cert item value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get certificate item value.
*
* @param { CertItemType } itemType
* @returns { DataBlob } cert item value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getItem(itemType: CertItemType): DataBlob;
/**
* Check the X509 cert if match the parameters.
*
* @param { X509CertMatchParameters } param - indicate the match parameters.
* @returns { boolean } true - match X509Cert, false - not match.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Check the X509 cert if match the parameters.
*
* @param { X509CertMatchParameters } param - indicate the match parameters.
* @returns { boolean } true - match X509Cert, false - not match.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
match(param: X509CertMatchParameters): boolean;
/**
* Obtain CRL distribution points.
*
* @returns { DataArray } X509 cert CRL distribution points.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getCRLDistributionPoint(): DataArray;
/**
* Get X500 distinguished name of the issuer.
*
* @returns { X500DistinguishedName } X500 distinguished name object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getIssuerX500DistinguishedName(): X500DistinguishedName;
/**
* Get X500 distinguished name of the subject.
*
* @returns { X500DistinguishedName } X500 distinguished name object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSubjectX500DistinguishedName(): X500DistinguishedName;
/**
* Get the string type data of the object.
*
* @returns { string } the string type data of the object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
/**
* Get the string type data of the object according to the encoding type.
*
* @param { EncodingType } encodingType indicates the encoding type.
* @returns { string } the string type data of the object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19020003 - parameter check failed. Possible causes:
* <br>1. The value of encodingType is not in the EncodingType enumeration range.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
toString(encodingType: EncodingType): string;
/**
* Get the hash value of DER format data.
*
* @returns { Uint8Array } the hash value of DER format data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
hashCode(): Uint8Array;
/**
* Get the extension der encoding data for the corresponding entity.
*
* @returns { CertExtension } the certExtension object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getExtensionsObject(): CertExtension;
}
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509Cert> } callback - the callback of createX509Cert.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509Cert> } callback - the callback of createX509Cert.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509Cert> } callback - the callback of createX509Cert.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX509Cert(inStream: EncodingBlob, callback: AsyncCallback<X509Cert>): void;
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509Cert> } the promise of X509 cert instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509Cert> } the promise of X509 cert instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create X509 certificate object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509Cert> } the promise of X509 cert instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX509Cert(inStream: EncodingBlob): Promise<X509Cert>;
/**
* The CertExtension interface is used to parse and verify certificate extension.
*
* @typedef CertExtension
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* The CertExtension interface is used to parse and verify certificate extension.
*
* @typedef CertExtension
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The CertExtension interface is used to parse and verify certificate extension.
*
* @typedef CertExtension
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertExtension {
/**
* Get certificate extension encoded data.
*
* @returns { EncodingBlob } cert extension encoded data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate extension encoded data.
*
* @returns { EncodingBlob } cert extension encoded data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get certificate extension encoded data.
*
* @returns { EncodingBlob } cert extension encoded data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(): EncodingBlob;
/**
* Get certificate extension oid list.
*
* @param { ExtensionOidType } valueType
* @returns { DataArray } cert extension OID list value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate extension oid list.
*
* @param { ExtensionOidType } valueType
* @returns { DataArray } cert extension OID list value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get certificate extension oid list.
*
* @param { ExtensionOidType } valueType
* @returns { DataArray } cert extension OID list value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getOidList(valueType: ExtensionOidType): DataArray;
/**
* Get certificate extension entry.
*
* @param { ExtensionEntryType } valueType
* @param { DataBlob } oid
* @returns { DataBlob } cert extension entry value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Get certificate extension entry.
*
* @param { ExtensionEntryType } valueType
* @param { DataBlob } oid
* @returns { DataBlob } cert extension entry value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get certificate extension entry.
*
* @param { ExtensionEntryType } valueType
* @param { DataBlob } oid
* @returns { DataBlob } cert extension entry value.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEntry(valueType: ExtensionEntryType, oid: DataBlob): DataBlob;
/**
* Check whether the certificate is a CA(The keyusage contains signature usage and the value of cA in BasicConstraints is true).
* If not a CA, return -1, otherwise return the path length constraint in BasicConstraints.
* If the certificate is a CA and the path length constraint does not appear, then return -2 to indicate that there is no limit to path length.
*
* @returns { number } path length constraint.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Check whether the certificate is a CA(The keyusage contains signature usage and the value of cA in BasicConstraints is true).
* If not a CA, return -1, otherwise return the path length constraint in BasicConstraints.
* If the certificate is a CA and the path length constraint does not appear, then return -2 to indicate that there is no limit to path length.
*
* @returns { number } path length constraint.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Check whether the certificate is a CA(The keyusage contains signature usage and the value of cA in BasicConstraints is true).
* If not a CA, return -1, otherwise return the path length constraint in BasicConstraints.
* If the certificate is a CA and the path length constraint does not appear, then return -2 to indicate that there is no limit to path length.
*
* @returns { number } path length constraint.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
checkCA(): number;
/**
* Check if exists Unsupported critical extension.
*
* @returns { boolean } true - exists unsupported critical extension, false - else.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Check if exists Unsupported critical extension.
*
* @returns { boolean } true - exists unsupported critical extension, false - else.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
hasUnsupportedCriticalExtension(): boolean;
}
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @param { AsyncCallback<CertExtension> } callback - the callback of of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @param { AsyncCallback<CertExtension> } callback - the callback of of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @param { AsyncCallback<CertExtension> } callback - the callback of of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createCertExtension(inStream: EncodingBlob, callback: AsyncCallback<CertExtension>): void;
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @returns { Promise<CertExtension> } the promise of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 10
*/
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @returns { Promise<CertExtension> } the promise of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create certificate extension object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert extensions data.
* @returns { Promise<CertExtension> } the promise of certificate extension instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createCertExtension(inStream: EncodingBlob): Promise<CertExtension>;
/**
* Interface of X509CrlEntry.
*
* @typedef X509CrlEntry
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry
*/
interface X509CrlEntry {
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getEncoded
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @returns { Promise<EncodingBlob> } the promise of crl entry blob data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getEncoded
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Get the serial number from this x509crl entry.
*
* @returns { number } serial number of crl entry.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getSerialNumber
*/
getSerialNumber(): number;
/**
* Get the issuer of the x509 certificate described by this entry.
*
* @returns { DataBlob } DataBlob of issuer.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getCertIssuer
*/
getCertIssuer(): DataBlob;
/**
* Get the revocation date from x509crl entry.
*
* @returns { string } string of revocation date.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRLEntry#getRevocationDate
*/
getRevocationDate(): string;
}
/**
* Interface of X509CRLEntry.
*
* @typedef X509CRLEntry
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Interface of X509CRLEntry.
*
* @typedef X509CRLEntry
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X509CRLEntry {
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @returns { Promise<EncodingBlob> } the promise of CRL entry blob data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Returns the ASN of this CRL entry 1 der coding form, i.e. internal sequence.
*
* @returns { Promise<EncodingBlob> } the promise of CRL entry blob data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Get the serial number from this x509CRL entry.
*
* @returns { bigint } serial number of CRL entry.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the serial number from this x509CRL entry.
*
* @returns { bigint } serial number of CRL entry.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSerialNumber(): bigint;
/**
* Get the issuer of the x509 certificate described by this entry.
*
* @returns { DataBlob } DataBlob of issuer.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the issuer of the x509 certificate described by this entry.
*
* @returns { DataBlob } DataBlob of issuer.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getCertIssuer(): DataBlob;
/**
* Get the issuer name of the x509 certificate described by this entry according to the encoding type.
*
* @param { EncodingType } encodingType indicates the encoding type.
* @returns { string } issuer name.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19020003 - parameter check failed. Possible causes:
* <br>1. The value of encodingType is not in the EncodingType enumeration range.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
getCertIssuer(encodingType: EncodingType): string;
/**
* Get the revocation date from x509CRL entry.
*
* @returns { string } string of revocation date.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the revocation date from x509CRL entry.
*
* @returns { string } string of revocation date.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getRevocationDate(): string;
/**
* Get Extensions of CRL Entry.
*
* @returns { DataBlob } DataBlob of extensions
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get Extensions of CRL Entry.
*
* @returns { DataBlob } DataBlob of extensions
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getExtensions(): DataBlob;
/**
* Check if CRL Entry has extension .
*
* @returns { boolean } true - CRL Entry has extension, false - else.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Check if CRL Entry has extension .
*
* @returns { boolean } true - CRL Entry has extension, false - else.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
hasExtensions(): boolean;
/**
* Get X500 distinguished name of the issuer.
*
* @returns { X500DistinguishedName } X500 distinguished name object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getCertIssuerX500DistinguishedName(): X500DistinguishedName;
/**
* Get the string type data of the object.
*
* @returns { string } the string type data of the object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
/**
* Get the hash value of DER format data.
*
* @returns { Uint8Array } the hash value of DER format data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
hashCode(): Uint8Array;
/**
* Get the extension der encoding data for the corresponding entity.
*
* @returns { CertExtension } the certExtension object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getExtensionsObject(): CertExtension;
}
/**
* Interface of X509Crl.
*
* @typedef X509Crl
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL
*/
interface X509Crl {
/**
* Check if the given certificate is on this CRL.
*
* @param { X509Cert } cert - input cert data.
* @returns { boolean } result of Check cert is revoked or not.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#isRevoked
*/
isRevoked(cert: X509Cert): boolean;
/**
* Returns the type of this CRL.
*
* @returns { string } string of crl type.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getType
*/
getType(): string;
/**
* Get the der coding format.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getEncoded
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Get the der coding format.
*
* @returns { Promise<EncodingBlob> } the promise of crl blob data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getEncoded
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @param { AsyncCallback<void> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#verify
*/
verify(key: cryptoFramework.PubKey, callback: AsyncCallback<void>): void;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#verify
*/
verify(key: cryptoFramework.PubKey): Promise<void>;
/**
* Get version number from CRL.
*
* @returns { number } version of crl.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getVersion
*/
getVersion(): number;
/**
* Get the issuer name from CRL. Issuer means the entity that signs and publishes the CRL.
*
* @returns { DataBlob } issuer name of crl.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getIssuerName
*/
getIssuerName(): DataBlob;
/**
* Get lastUpdate value from CRL.
*
* @returns { string } last update of crl.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getLastUpdate
*/
getLastUpdate(): string;
/**
* Get nextUpdate value from CRL.
*
* @returns { string } next update of crl.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getNextUpdate
*/
getNextUpdate(): string;
/**
* This method can be used to find CRL entries in specified CRLs.
*
* @param { number } serialNumber - serial number of crl.
* @returns { X509CrlEntry } next update of crl.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCert
*/
getRevokedCert(serialNumber: number): X509CrlEntry;
/**
* This method can be used to find CRL entries in specified cert.
*
* @param { X509Cert } cert - cert of x509.
* @returns { X509CrlEntry } X509CrlEntry instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCertWithCert
*/
getRevokedCertWithCert(cert: X509Cert): X509CrlEntry;
/**
* Get all entries in this CRL.
*
* @param { AsyncCallback<Array<X509CrlEntry>> } callback - the callback of getRevokedCerts.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCerts
*/
getRevokedCerts(callback: AsyncCallback<Array<X509CrlEntry>>): void;
/**
* Get all entries in this CRL.
*
* @returns { Promise<Array<X509CrlEntry>> } the promise of X509CrlEntry instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getRevokedCerts
*/
getRevokedCerts(): Promise<Array<X509CrlEntry>>;
/**
* Get the CRL information encoded by Der from this CRL.
*
* @returns { DataBlob } DataBlob of tbs info.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getTBSInfo
*/
getTbsInfo(): DataBlob;
/**
* Get signature value from CRL.
*
* @returns { DataBlob } DataBlob of signature.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignature
*/
getSignature(): DataBlob;
/**
* Get the signature algorithm name of the CRL signature algorithm.
*
* @returns { string } string of signature algorithm name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignatureAlgName
*/
getSignatureAlgName(): string;
/**
* Get the signature algorithm oid string from CRL.
*
* @returns { string } string of signature algorithm oid.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignatureAlgOid
*/
getSignatureAlgOid(): string;
/**
* Get the der encoded signature algorithm parameters from the CRL signature algorithm.
*
* @returns { DataBlob } DataBlob of signature algorithm params.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert.X509CRL#getSignatureAlgParams
*/
getSignatureAlgParams(): DataBlob;
}
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @param { AsyncCallback<X509Crl> } callback - the callback of createX509Crl to return x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert#createX509CRL
*/
function createX509Crl(inStream: EncodingBlob, callback: AsyncCallback<X509Crl>): void;
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @returns { Promise<X509Crl> } the promise of x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @since 9
* @deprecated since 11
* @useinstead ohos.security.cert#createX509CRL
*/
function createX509Crl(inStream: EncodingBlob): Promise<X509Crl>;
/**
* Interface of X509CRL.
*
* @typedef X509CRL
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Interface of X509CRL.
*
* @typedef X509CRL
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X509CRL {
/**
* Check if the given certificate is on this CRL.
*
* @param { X509Cert } cert - input cert data.
* @returns { boolean } result of Check cert is revoked or not.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Check if the given certificate is on this CRL.
*
* @param { X509Cert } cert - input cert data.
* @returns { boolean } result of Check cert is revoked or not.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
isRevoked(cert: X509Cert): boolean;
/**
* Returns the type of this CRL.
*
* @returns { string } string of CRL type.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Returns the type of this CRL.
*
* @returns { string } string of CRL type.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getType(): string;
/**
* Get the der coding format.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the der coding format.
*
* @param { AsyncCallback<EncodingBlob> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(callback: AsyncCallback<EncodingBlob>): void;
/**
* Get the der coding format.
*
* @returns { Promise<EncodingBlob> } the promise of CRL blob data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the der coding format.
*
* @returns { Promise<EncodingBlob> } the promise of CRL blob data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(): Promise<EncodingBlob>;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @param { AsyncCallback<void> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @param { AsyncCallback<void> } callback - the callback of getEncoded.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
verify(key: cryptoFramework.PubKey, callback: AsyncCallback<void>): void;
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Use the public key to verify the signature of CRL.
*
* @param { cryptoFramework.PubKey } key - input public Key.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
verify(key: cryptoFramework.PubKey): Promise<void>;
/**
* Get version number from CRL.
*
* @returns { number } version of CRL.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get version number from CRL.
*
* @returns { number } version of CRL.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getVersion(): number;
/**
* Get the issuer name from CRL. Issuer means the entity that signs and publishes the CRL.
*
* @returns { DataBlob } issuer name of CRL.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the issuer name from CRL. Issuer means the entity that signs and publishes the CRL.
*
* @returns { DataBlob } issuer name of CRL.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getIssuerName(): DataBlob;
/**
* Get the issuer name from CRL according to the encoding type.
*
* @param { EncodingType } encodingType indicates the encoding type.
* @returns { string } issuer name of CRL.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19020003 - parameter check failed. Possible causes:
* <br>1. The value of encodingType is not in the EncodingType enumeration range.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
getIssuerName(encodingType: EncodingType): string;
/**
* Get lastUpdate value from CRL.
*
* @returns { string } last update of CRL.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get lastUpdate value from CRL.
*
* @returns { string } last update of CRL.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getLastUpdate(): string;
/**
* Get nextUpdate value from CRL.
*
* @returns { string } next update of CRL.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get nextUpdate value from CRL.
*
* @returns { string } next update of CRL.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getNextUpdate(): string;
/**
* This method can be used to find CRL entries in specified CRLs.
*
* @param { bigint } serialNumber - serial number of CRL.
* @returns { X509CRLEntry } next update of CRL.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* This method can be used to find CRL entries in specified CRLs.
*
* @param { bigint } serialNumber - serial number of CRL.
* @returns { X509CRLEntry } next update of CRL.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getRevokedCert(serialNumber: bigint): X509CRLEntry;
/**
* This method can be used to find CRL entries in specified cert.
*
* @param { X509Cert } cert - cert of x509.
* @returns { X509CRLEntry } X509CRLEntry instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* This method can be used to find CRL entries in specified cert.
*
* @param { X509Cert } cert - cert of x509.
* @returns { X509CRLEntry } X509CRLEntry instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getRevokedCertWithCert(cert: X509Cert): X509CRLEntry;
/**
* Get all entries in this CRL.
*
* @param { AsyncCallback<Array<X509CRLEntry>> } callback - the callback of getRevokedCerts.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get all entries in this CRL.
*
* @param { AsyncCallback<Array<X509CRLEntry>> } callback - the callback of getRevokedCerts.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getRevokedCerts(callback: AsyncCallback<Array<X509CRLEntry>>): void;
/**
* Get all entries in this CRL.
*
* @returns { Promise<Array<X509CRLEntry>> } the promise of X509CRLEntry instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get all entries in this CRL.
*
* @returns { Promise<Array<X509CRLEntry>> } the promise of X509CRLEntry instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types;
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getRevokedCerts(): Promise<Array<X509CRLEntry>>;
/**
* Get the CRL information encoded by Der from this CRL.
*
* @returns { DataBlob } DataBlob of tbs info.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the CRL information encoded by Der from this CRL.
*
* @returns { DataBlob } DataBlob of tbs info.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getTBSInfo(): DataBlob;
/**
* Get signature value from CRL.
*
* @returns { DataBlob } DataBlob of signature.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get signature value from CRL.
*
* @returns { DataBlob } DataBlob of signature.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignature(): DataBlob;
/**
* Get the signature algorithm name of the CRL signature algorithm.
*
* @returns { string } string of signature algorithm name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the signature algorithm name of the CRL signature algorithm.
*
* @returns { string } string of signature algorithm name.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignatureAlgName(): string;
/**
* Get the signature algorithm oid string from CRL.
*
* @returns { string } string of signature algorithm oid.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the signature algorithm oid string from CRL.
*
* @returns { string } string of signature algorithm oid.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignatureAlgOid(): string;
/**
* Get the der encoded signature algorithm parameters from the CRL signature algorithm.
*
* @returns { DataBlob } DataBlob of signature algorithm params.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the der encoded signature algorithm parameters from the CRL signature algorithm.
*
* @returns { DataBlob } DataBlob of signature algorithm params.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getSignatureAlgParams(): DataBlob;
/**
* Get Extensions of CRL Entry.
*
* @returns { DataBlob } DataBlob of extensions
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get Extensions of CRL Entry.
*
* @returns { DataBlob } DataBlob of extensions
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getExtensions(): DataBlob;
/**
* Check if the X509 CRL match the parameters.
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @returns { boolean } true - match X509CRL, false - not match.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Check if the X509 CRL match the parameters.
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @returns { boolean } true - match X509CRL, false - not match.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
match(param: X509CRLMatchParameters): boolean;
/**
* Get X500 distinguished name of the issuer.
*
* @returns { X500DistinguishedName } X500 distinguished name object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getIssuerX500DistinguishedName(): X500DistinguishedName;
/**
* Get the string type data of the object.
*
* @returns { string } the string type data of the object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
/**
* Get the string type data of the object according to the encoding type.
*
* @param { EncodingType } encodingType indicates the encoding type.
* @returns { string } the string type data of the object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19020003 - parameter check failed. Possible causes:
* <br>1. The value of encodingType is not in the EncodingType enumeration range.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
toString(encodingType: EncodingType): string;
/**
* Get the hash value of DER format data.
*
* @returns { Uint8Array } the hash value of DER format data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
hashCode(): Uint8Array;
/**
* Get the extension der encoding data for the corresponding entity.
*
* @returns { CertExtension } the certExtension object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getExtensionsObject(): CertExtension;
}
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @param { AsyncCallback<X509CRL> } callback - the callback of createX509CRL to return x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @param { AsyncCallback<X509CRL> } callback - the callback of createX509CRL to return x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX509CRL(inStream: EncodingBlob, callback: AsyncCallback<X509CRL>): void;
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @returns { Promise<X509CRL> } the promise of x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create X509 CRL object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicates the input CRL data.
* @returns { Promise<X509CRL> } the promise of x509 CRL instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX509CRL(inStream: EncodingBlob): Promise<X509CRL>;
/**
* Certification chain validator.
*
* @typedef CertChainValidator
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Certification chain validator.
*
* @typedef CertChainValidator
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Certification chain validator.
*
* @typedef CertChainValidator
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertChainValidator {
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @param { AsyncCallback<void> } callback - the callback of validate.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @param { AsyncCallback<void> } callback - the callback of validate.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @param { AsyncCallback<void> } callback - the callback of validate.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
validate(certChain: CertChainData, callback: AsyncCallback<void>): void;
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Validate the cert chain.
*
* @param { CertChainData } certChain - indicate the cert chain validator data.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
validate(certChain: CertChainData): Promise<void>;
/**
* The cert chain related algorithm.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* The cert chain related algorithm.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The cert chain related algorithm.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
readonly algorithm: string;
}
/**
* Provides to create certificate chain object. The returned object provides the verification capability.
*
* @param { string } algorithm - indicates the cert chain validator type.
* @returns { CertChainValidator } the cert chain validator instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @since 9
*/
/**
* Provides to create certificate chain object. The returned object provides the verification capability.
*
* @param { string } algorithm - indicates the cert chain validator type.
* @returns { CertChainValidator } the cert chain validator instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create certificate chain object. The returned object provides the verification capability.
*
* @param { string } algorithm - indicates the cert chain validator type.
* @returns { CertChainValidator } the cert chain validator instance.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - this operation is not supported.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createCertChainValidator(algorithm: string): CertChainValidator;
/**
* Enum for general name use type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum GeneralNameType {
/**
* Indicates the name used for other.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_OTHER_NAME = 0,
/**
* Indicates the name used for RFC822.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_RFC822_NAME = 1,
/**
* Indicates the name used for DNS.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_DNS_NAME = 2,
/**
* Indicates the name used for X.400 address.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_X400_ADDRESS = 3,
/**
* Indicates the name used for X.500 directory.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_DIRECTORY_NAME = 4,
/**
* Indicates the name used for EDI.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_EDI_PARTY_NAME = 5,
/**
* Indicates the name used for URI.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_UNIFORM_RESOURCE_ID = 6,
/**
* Indicates the name used for IP address.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_IP_ADDRESS = 7,
/**
* Indicates the name used for registered ID.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
GENERAL_NAME_TYPE_REGISTERED_ID = 8
}
/**
* GeneralName object
*
* @typedef GeneralName
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface GeneralName {
/**
* The general name type.
*
* @type { GeneralNameType }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
type: GeneralNameType;
/**
* The general name in DER format
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
name?: Uint8Array;
}
/**
* X509 Cert match parameters
*
* @typedef X509CertMatchParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* X509 Cert match parameters
*
* @typedef X509CertMatchParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X509CertMatchParameters {
/**
* To match SubjectAlternativeNames of cert extensions:
* [Rule]
* null : Do not match.
* NOT null : match after [matchAllSubjectAltNames]
*
* @type { ?Array<GeneralName> } SubjectAlternativeNames is in DER encoding format
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
subjectAlternativeNames?: Array<GeneralName>;
/**
* Indicate if match all subject alternate name:
* [Rule]
* true : match if [subjectAlternativeNames] is equal with all of [SubjectAlternativeNames of cert extensions]
* false : match if [subjectAlternativeNames] is only equal with one of [SubjectAlternativeNames of cert extensions]
*
* @type { ?boolean }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
matchAllSubjectAltNames?: boolean;
/**
* To match AuthorityKeyIdentifier of cert extensions in DER encoding:
* [Rule]
* null : Do not match.
* NOT null : match if it is equal with [AuthorityKeyIdentifier of cert extensions] in DER encoding
*
* @type { ?Uint8Array } the key identifier
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
authorityKeyIdentifier?: Uint8Array;
/**
* To match BaseConstraints.pathLenConstraint of cert extensions:
* [Rule]
* >=0 : The certificate must contain BaseConstraints extension, and the cA field in the extension takes.
* -2 : The cA field in the BaseConstraints extension of the certificate must be set to false or the certificate does not contain BaseConstraints extension.
* other : Do not match.
*
* @type { ?number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
minPathLenConstraint?: number;
/**
* To match X509Cert:
* [Rule]
* null : Do not match.
* NOT null : match if x509Cert.getEncoding is equal.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* To match X509Cert:
* [Rule]
* null : Do not match.
* NOT null : match if x509Cert.getEncoding is equal.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
x509Cert?: X509Cert;
/**
* To match the validDate of cert:
* [Rule]
* null : Do not match.
* NOT null : match if [notBefore of cert] <= [validDate] <= [notAfter of cert].
*
* @type { ?string } format is YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* To match the validDate of cert:
* [Rule]
* null : Do not match.
* NOT null : match if [notBefore of cert] <= [validDate] <= [notAfter of cert].
*
* @type { ?string } format is YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
validDate?: string;
/**
* To match the issuer of cert:
* [Rule]
* null : Do not match.
* NOT null : match if it is equal with [issuer of cert] in DER encoding.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* To match the issuer of cert:
* [Rule]
* null : Do not match.
* NOT null : match if it is equal with [issuer of cert] in DER encoding.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
issuer?: Uint8Array;
/**
* To match the ExtendedKeyUsage of cert extensions:
* [Rule]
* null : Do not match.
* NOT null : match ok if [ExtendedKeyUsage of cert extensions] is null, or
* [ExtendedKeyUsage of cert extensions] include [extendedKeyUsage].
*
* @type { ?Array<string> } array of oIDs.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
extendedKeyUsage?: Array<string>;
/**
* The X509Certificate must have subject and subject alternative names that meet the specified name constraints:
* [Rule]
* null : Do not match.
* NOT null : match ok if [NameConstraints of cert extensions] is null, or
* [NameConstraints of cert extensions] include [nameConstraints].
*
* @type { ?Uint8Array } ASN.1 DER encoded form of nameConstraints
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
nameConstraints?: Uint8Array;
/**
* The X509Certificate must have subject and subject alternative names that meet the specified name constraints:
* [Rule]
* null : Do not match.
* NOT null : match ok if [Certificate Policies of cert extensions] is null, or
* [Certificate Policies of cert extensions] include [certPolicy].
*
* @type { ?Array<string> } array of oIDs.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
certPolicy?: Array<string>;
/**
* The specified date must fall within the private key validity period for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if [Private Key Valid Period of cert extensions] is null, or
* [privateKeyValid] fall in [Private Key Valid Period of cert extensions].
*
* @type { ?string } format is YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
privateKeyValid?: string;
/**
* To match the KeyUsage of cert extensions:
* [Rule]
* null : Do not match.
* NOT null : match ok if [KeyUsage of cert extensions] is null, or
* [KeyUsage of cert extensions] include [keyUsage].
*
* @type { ?Array<boolean> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* To match the KeyUsage of cert extensions:
* [Rule]
* null : Do not match.
* NOT null : match ok if [KeyUsage of cert extensions] is null, or
* [KeyUsage of cert extensions] include [keyUsage].
*
* @type { ?Array<boolean> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
keyUsage?: Array<boolean>;
/**
* The specified serial number must match the serialnumber for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [serialNumber of cert].
*
* @type { ?bigint }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The specified serial number must match the serialnumber for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [serialNumber of cert].
*
* @type { ?bigint }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
serialNumber?: bigint;
/**
* The specified value must match the subject for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [subject of cert].
*
* @type { ?Uint8Array } subject in DER encoding format
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The specified value must match the subject for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [subject of cert].
*
* @type { ?Uint8Array } subject in DER encoding format
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
subject?: Uint8Array;
/**
* The specified value must match the Subject Key Identifier extension for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [Subject Key Identifier of cert extensions].
*
* @type { ?Uint8Array } subjectKeyIdentifier in DER encoding format ??
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
subjectKeyIdentifier?: Uint8Array;
/**
* The specified value must match the publicKey for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [publicKey of cert].
*
* @type { ?DataBlob } publicKey
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The specified value must match the publicKey for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [publicKey of cert].
*
* @type { ?DataBlob } publicKey
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
publicKey?: DataBlob;
/**
* The specified value must match the publicKey for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [publicKey of cert].
*
* @type { ?string } the object identifier (OID) of the signature algorithm to check.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The specified value must match the publicKey for the X509Certificate:
* [Rule]
* null : Do not match.
* NOT null : match ok if it is equal with [publicKey of cert].
*
* @type { ?string } the object identifier (OID) of the signature algorithm to check.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
publicKeyAlgID?: string;
}
/**
* X509 CRL match parameters
*
* @typedef X509CRLMatchParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* X509 CRL match parameters
*
* @typedef X509CRLMatchParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X509CRLMatchParameters {
/**
* To match the issuer of cert:
* [Rule]
* null : Do not match.
* NOT null : match if it is equal with [issuer of cert] in DER encoding.
*
* @type { ?Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* To match the issuer of cert:
* [Rule]
* null : Do not match.
* NOT null : match if it is equal with [issuer of cert] in DER encoding.
*
* @type { ?Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
issuer?: Array<Uint8Array>;
/**
* To match X509Cert:
* [Rule]
* null : Do not match.
* NOT null : match if x509Cert.getEncoding is equal.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* To match X509Cert:
* [Rule]
* null : Do not match.
* NOT null : match if x509Cert.getEncoding is equal.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
x509Cert?: X509Cert;
/**
* To match updateDateTime of CRL:
* [Rule]
* null : Do not verify.
* NOT null : verify if [thisUpdate in CRL] <= updateDateTime <= [nextUpdate in CRL]
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
updateDateTime?: string;
/**
* To match the maximum of CRL number extension:
* [Rule]
* null : Do not verify.
* NOT null : verify if [CRL number extension] <= maxCRL.
*
* @type { ?bigint }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
maxCRL?: bigint;
/**
* To match the minimum of CRL number extension:
* [Rule]
* null : Do not verify.
* NOT null : verify if [CRL number extension] >= minCRL.
*
* @type { ?bigint }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
minCRL?: bigint;
}
/**
* The certificate and CRL collection object.
*
* @typedef CertCRLCollection
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The certificate and CRL collection object.
*
* @typedef CertCRLCollection
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertCRLCollection {
/**
* return all Array<X509Cert> which match X509CertMatchParameters
*
* @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object.
* @returns { Promise<Array<X509Cert>> }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* return all Array<X509Cert> which match X509CertMatchParameters
*
* @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object.
* @returns { Promise<Array<X509Cert>> }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
selectCerts(param: X509CertMatchParameters): Promise<Array<X509Cert>>;
/**
* return the X509 Cert which match X509CertMatchParameters
*
* @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object.
* @param { AsyncCallback<Array<X509Cert>> } callback - the callback of select cert.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* return the X509 Cert which match X509CertMatchParameters
*
* @param { X509CertMatchParameters } param - indicate the X509CertMatchParameters object.
* @param { AsyncCallback<Array<X509Cert>> } callback - the callback of select cert.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
selectCerts(param: X509CertMatchParameters, callback: AsyncCallback<Array<X509Cert>>): void;
/**
* return all X509 CRL which match X509CRLMatchParameters
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @returns { Promise<Array<X509CRL>> }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* return all X509 CRL which match X509CRLMatchParameters
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @returns { Promise<Array<X509CRL>> }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
selectCRLs(param: X509CRLMatchParameters): Promise<Array<X509CRL>>;
/**
* return all X509 CRL which match X509CRLMatchParameters
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @param { AsyncCallback<Array<X509CRL>> } callback - the callback of select CRL.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* return all X509 CRL which match X509CRLMatchParameters
*
* @param { X509CRLMatchParameters } param - indicate the X509CRLMatchParameters object.
* @param { AsyncCallback<Array<X509CRL>> } callback - the callback of select CRL.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
selectCRLs(param: X509CRLMatchParameters, callback: AsyncCallback<Array<X509CRL>>): void;
}
/**
* create object CertCRLCollection
*
* @param { Array<X509Cert> } certs - array of X509Cert.
* @param { Array<X509CRL> } [options] crls - array of X509CRL.
* @returns { CertCRLCollection }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* create object CertCRLCollection
*
* @param { Array<X509Cert> } certs - array of X509Cert.
* @param { Array<X509CRL> } [crls] - array of X509CRL.
* @returns { CertCRLCollection }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createCertCRLCollection(certs: Array<X509Cert>, crls?: Array<X509CRL>): CertCRLCollection;
/**
* X509 Certification chain object.
*
* @typedef X509CertChain
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* X509 Certification chain object.
*
* @typedef X509CertChain
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X509CertChain {
/**
* Get the X509 certificate list.
*
* @returns { Array<X509Cert> } the X509 certificate list.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Get the X509 certificate list.
*
* @returns { Array<X509Cert> } the X509 certificate list.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getCertList(): Array<X509Cert>;
/**
* Validate the cert chain with validate parameters.
*
* @param { CertChainValidationParameters } param - indicate the cert chain Validate parameters.
* @returns { Promise<CertChainValidationResult> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Validate the cert chain with validate parameters.
*
* @param { CertChainValidationParameters } param - indicate the cert chain Validate parameters.
* @returns { Promise<CertChainValidationResult> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
validate(param: CertChainValidationParameters): Promise<CertChainValidationResult>;
/**
* Validate the cert chain with validate parameters.
*
* @param { CertChainValidationParameters } param - indicate the cert chain validate parameters.
* @param { AsyncCallback<CertChainValidationResult> } callback - indicate the cert chain validate result.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Validate the cert chain with validate parameters.
*
* @param { CertChainValidationParameters } param - indicate the cert chain validate parameters.
* @param { AsyncCallback<CertChainValidationResult> } callback - indicate the cert chain validate result.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
validate(param: CertChainValidationParameters, callback: AsyncCallback<CertChainValidationResult>): void;
/**
* Get the string type data of the object.
*
* @returns { string } the string type data of the object.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
/**
* Get the hash value of DER format data.
*
* @returns { Uint8Array } the hash value of DER format data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
hashCode(): Uint8Array;
}
/**
* Provides to create X509 certificate chain object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509CertChain> }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create X509 certificate chain object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @returns { Promise<X509CertChain> }
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX509CertChain(inStream: EncodingBlob): Promise<X509CertChain>;
/**
* Provides to create X509 certificate chain object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509CertChain> } callback
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides to create X509 certificate chain object.
* The returned object provides the data parsing or verification capability.
*
* @param { EncodingBlob } inStream - indicate the input cert data.
* @param { AsyncCallback<X509CertChain> } callback
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX509CertChain(inStream: EncodingBlob, callback: AsyncCallback<X509CertChain>): void;
/**
* Create certificate chain object with certificate array.
*
* @param { Array<X509Cert> } certs - indicate the certificate array.
* @returns { X509CertChain } the certificate chain object.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Create certificate chain object with certificate array.
*
* @param { Array<X509Cert> } certs - indicate the certificate array.
* @returns { X509CertChain } the certificate chain object.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX509CertChain(certs: Array<X509Cert>): X509CertChain;
/**
* Create and validate a certificate chain with the build parameters.
*
* @param { CertChainBuildParameters } param - indicate the certificate chain build parameters.
* @returns { Promise<CertChainBuildResult> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function buildX509CertChain(param: CertChainBuildParameters): Promise<CertChainBuildResult>;
/**
* The encoding base format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
enum EncodingBaseFormat {
/**
* PEM format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
PEM = 0,
/**
* DER format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
DER = 1,
}
/**
* PKCS12 data.
*
* @typedef Pkcs12Data
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface Pkcs12Data {
/**
* The private key.
*
* @type { ?(string | Uint8Array) }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
privateKey?: string | Uint8Array;
/**
* The certificate corresponding to the private key.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
cert?: X509Cert;
/**
* The other certificates.
*
* @type { ?Array<X509Cert> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
otherCerts?: Array<X509Cert>;
}
/**
* PKCS12 parsing config.
*
* @typedef Pkcs12ParsingConfig
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface Pkcs12ParsingConfig {
/**
* The password of the PKCS12.
*
* @type { string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
password: string;
/**
* Whether to get the private key.
*
* @type { ?boolean }
* @default true
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
needsPrivateKey?: boolean;
/**
* The output format of the private key.
*
* @type { ?EncodingBaseFormat }
* @default EncodingBaseFormat.PEM
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
privateKeyFormat?: EncodingBaseFormat;
/**
* Whether to get the certificate corresponding to the private key.
*
* @type { ?boolean }
* @default true
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
needsCert?: boolean;
/**
* Whether to get other certificates.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
needsOtherCerts?: boolean;
}
/**
* Parse PKCS12.
*
* @param { Uint8Array } data - the PKCS12 data.
* @param { Pkcs12ParsingConfig } config - the configuration for parsing PKCS12.
* @returns { Pkcs12Data } the Pkcs12Data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030008 - maybe wrong password.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
function parsePkcs12(data: Uint8Array, config: Pkcs12ParsingConfig): Pkcs12Data;
/**
* Get trust anchor array from specified P12.
*
* @param { Uint8Array } keystore - the file path of the P12.
* @param { string } pwd - the password of the P12.
* @returns { Promise<Array<X509TrustAnchor>> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createTrustAnchorsWithKeyStore(keystore: Uint8Array, pwd: string): Promise<Array<X509TrustAnchor>>;
/**
* Create X500DistinguishedName object with the name in string format.
*
* @param { string } nameStr - the string format of the Name type defined by X509.
* @returns { Promise<X500DistinguishedName> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX500DistinguishedName(nameStr: string): Promise<X500DistinguishedName>;
/**
* Create X500DistinguishedName object with the name in DER format.
*
* @param { Uint8Array } nameDer - the DER format of the Name type defined by X509.
* @returns { Promise<X500DistinguishedName> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030002 - the certificate signature verification failed.
* @throws { BusinessError } 19030003 - the certificate has not taken effect.
* @throws { BusinessError } 19030004 - the certificate has expired.
* @throws { BusinessError } 19030005 - failed to obtain the certificate issuer.
* @throws { BusinessError } 19030006 - the key cannot be used for signing a certificate.
* @throws { BusinessError } 19030007 - the key cannot be used for digital signature.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
function createX500DistinguishedName(nameDer: Uint8Array): Promise<X500DistinguishedName>;
/**
* Provides the x500 distinguished name type.
*
* @typedef X500DistinguishedName
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X500DistinguishedName {
/**
* Get distinguished name string in ASCII encoding type.
*
* @returns { string } distinguished name string.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getName(): string;
/**
* Get distinguished name string according to the encoding type.
*
* @param { EncodingType } encodingType - the specified encoding type.
* @returns { string } distinguished name string.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19020003 - parameter check failed. Possible causes:
* <br>1. The value of encodingType is not in the EncodingType enumeration range.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
getName(encodingType: EncodingType): string;
/**
* Get distinguished name string by type.
*
* @param { string } type - the specified type name.
* @returns { Array<string> } distinguished name string.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getName(type: string): Array<string>;
/**
* Get distinguished name in der coding format.
*
* @returns { EncodingBlob } distinguished name encoded data.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
getEncoded(): EncodingBlob;
}
/**
* Provides the x509 trust anchor type.
*
* @typedef X509TrustAnchor
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides the x509 trust anchor type.
*
* @typedef X509TrustAnchor
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface X509TrustAnchor {
/**
* The trust CA cert.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The trust CA cert.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CACert?: X509Cert;
/**
* The trust CA public key in DER format.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The trust CA public key in DER format.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CAPubKey?: Uint8Array;
/**
* The trust CA subject in DER format.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The trust CA subject in DER format.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
CASubject?: Uint8Array;
/**
* The name constraints in DER format.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
nameConstraints?: Uint8Array;
}
/**
* Enum for revocation check option.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum RevocationCheckOptions {
/**
* Indicates priority to use OCSP for verification.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
REVOCATION_CHECK_OPTION_PREFER_OCSP = 0,
/**
* Indicates support for verifying revocation status by accessing the network to obtain CRL or OCSP responses.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
REVOCATION_CHECK_OPTION_ACCESS_NETWORK,
/**
* Indicates when the 'REVOCATION_CHECK_OPTION_ACCESS_NETWORK' option is turned on, it is effective.
* If the preferred verification method is unable to verify the certificate status due to network reasons,
* an alternative solution will be used for verification.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
REVOCATION_CHECK_OPTION_FALLBACK_NO_PREFER,
/**
* Indicates when the 'REVOCATION_CHECK_OPTION_ACCESS_NETWORK' option is turned on, it is effective.
* If both the CRL and OCSP responses obtained online cannot verify the certificate status due to network reasons,
* the locally set CRL and OCSP responses will be used for verification.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
REVOCATION_CHECK_OPTION_FALLBACK_LOCAL
}
/**
* Enum for validation policy type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum ValidationPolicyType {
/**
* Indicates not need to verify the sslHostname field in the certificate.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
VALIDATION_POLICY_TYPE_X509 = 0,
/**
* Indicates need to verify the sslHostname field in the certificate.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
VALIDATION_POLICY_TYPE_SSL
}
/**
* Enum for validation keyusage type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
enum KeyUsageType {
/**
* Indicates the certificate public key can be used for digital signature operations.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_DIGITAL_SIGNATURE = 0,
/**
* Indicates certificate public key can be used for non repudiation operations, preventing the signer from denying their signature.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_NON_REPUDIATION,
/**
* Indicates certificate public key can be used for key encryption operations, for encrypting symmetric keys, etc.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_KEY_ENCIPHERMENT,
/**
* Indicates certificate public key can be used for data encryption operations, to encrypt data.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_DATA_ENCIPHERMENT,
/**
* Indicates certificate public key can be used for key negotiation operations, to negotiate shared keys.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_KEY_AGREEMENT,
/**
* Indicates certificate public key can be used for certificate signing operations.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_KEY_CERT_SIGN,
/**
* Indicates certificate public key can be used for signing operations on certificate revocation lists (CRLs).
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_CRL_SIGN,
/**
* Indicates the key can only be used for encryption operations and cannot be used for decryption operations.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_ENCIPHER_ONLY,
/**
* Indicates the key can only be used for decryption operations and cannot be used for encryption operations.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
KEYUSAGE_DECIPHER_ONLY
}
/**
* Provides the certificate chain validate revocation parameters.
*
* @typedef RevocationCheckParameter
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface RevocationCheckParameter {
/**
* The additional field for sending OCSP requests.
*
* @type { ?Array<Uint8Array> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ocspRequestExtension?: Array<Uint8Array>;
/**
* The server URL address for sending requests to OCSP.
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ocspResponderURI?: string;
/**
* The signing certificate for verifying OCSP response signatures.
*
* @type { ?X509Cert }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ocspResponderCert?: X509Cert;
/**
* The OCSP response message returned by an OCSP server.
*
* @type { ?Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ocspResponses?: Uint8Array;
/**
* The URL address for downloading the CRL list.
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
crlDownloadURI?: string;
/**
* The certificate revocation status verification option.
*
* @type { ?Array<RevocationCheckOptions> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
options?: Array<RevocationCheckOptions>;
/**
* The digest used to generate the ocsp cert id.
*
* @type { ?string }
* @default SHA256
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
ocspDigest?: string;
}
/**
* Provides the certificate chain validate parameters type.
*
* @typedef CertChainValidationParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Provides the certificate chain validate parameters type.
*
* @typedef CertChainValidationParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertChainValidationParameters {
/**
* The datetime to verify the certificate chain validity period.
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The datetime to verify the certificate chain validity period.
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
date?: string;
/**
* The trust ca certificates to verify the certificate chain.
*
* @type { Array<X509TrustAnchor> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The trust ca certificates to verify the certificate chain.
*
* @type { Array<X509TrustAnchor> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
trustAnchors: Array<X509TrustAnchor>;
/**
* Indicates whether to use system preinstalled CA certificates to verify the certificate chain.
*
* If set to true and trustAnchors is not an empty array, both user trustAnchors and system preinstalled CA
* certificates are used to verify the certificate chain.
*
* If set to true and trustAnchors is an empty array, only system preinstalled CA certificates are used to verify
* the certificate chain.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 20
*/
trustSystemCa?: boolean;
/**
* The cert and CRL list to build cert chain and verify the certificate chain revocation state.
*
* @type { ?Array<CertCRLCollection> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The cert and CRL list to build cert chain and verify the certificate chain revocation state.
*
* @type { ?Array<CertCRLCollection> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
certCRLs?: Array<CertCRLCollection>;
/**
* The revocation parameters to verify the certificate chain revocation status.
*
* @type { ?RevocationCheckParameter }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
revocationCheckParam?: RevocationCheckParameter;
/**
* The policy to verify the certificate chain validity.
*
* @type { ?ValidationPolicyType }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
policy?: ValidationPolicyType;
/**
* The sslHostname to verify the certificate chain validity.
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
sslHostname?: string;
/**
* The keyUsage to verify the certificate chain validity.
*
* @type { ?Array<KeyUsageType> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
keyUsage?: Array<KeyUsageType>;
}
/**
* Certification chain validate result.
*
* @typedef CertChainValidationResult
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* Certification chain validate result.
*
* @typedef CertChainValidationResult
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertChainValidationResult {
/**
* The cert chain trust anchor.
*
* @type { X509TrustAnchor }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The cert chain trust anchor.
*
* @type { X509TrustAnchor }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
readonly trustAnchor: X509TrustAnchor;
/**
* The target certificate.
*
* @type { X509Cert }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @since 11
*/
/**
* The target certificate.
*
* @type { X509Cert }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
readonly entityCert: X509Cert;
}
/**
* Provides the certificate chain build parameters type.
*
* @typedef CertChainBuildParameters
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertChainBuildParameters {
/**
* The certificate match parameters to selects certificate from the certificate collection.
*
* @type { X509CertMatchParameters }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
certMatchParameters: X509CertMatchParameters;
/**
* The maximum length of the certificate chain to be built.
*
* @type { ?number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
maxLength?: number;
/**
* The CertChain validation parameters.
*
* @type { CertChainValidationParameters }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
validationParameters: CertChainValidationParameters;
}
/**
* Certification chain build result.
*
* @typedef CertChainBuildResult
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
interface CertChainBuildResult {
/**
* The certificate chain of build result.
*
* @type { X509CertChain }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
readonly certChain: X509CertChain;
/**
* The certificate chain validation result.
*
* @type { CertChainValidationResult }
* @readonly
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 12
*/
readonly validationResult: CertChainValidationResult;
}
/**
* Enum for CMS content type.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
enum CmsContentType {
/**
* Signed data.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
SIGNED_DATA = 0
}
/**
* Enum for CMS content data format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
enum CmsContentDataFormat {
/**
* Binary format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
BINARY = 0,
/**
* Text format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
TEXT = 1
}
/**
* Enum for CMS format.
*
* @enum { number }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
enum CmsFormat {
/**
* PEM format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
PEM = 0,
/**
* DER format.
*
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
DER = 1
}
/**
* Private key info.
*
* @typedef PrivateKeyInfo
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface PrivateKeyInfo {
/**
* The unencrypted or encrypted private key, in PEM or DER format.
*
* @type { string | Uint8Array }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
key: string | Uint8Array;
/**
* The password of the private key, if the private key is encrypted.
*
* @type { ?string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
password?: string;
}
/**
* Configuration options for CMS signer.
*
* @typedef CmsSignerConfig
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface CmsSignerConfig {
/**
* Digest algorithm name, such as "SHA384".
*
* @type { string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
mdName: string;
/**
* Whether to add the certificate.
*
* @type { ?boolean }
* @default true
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
addCert?: boolean;
/**
* Whether to add the signature attributes.
*
* @type { ?boolean }
* @default true
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
addAttr?: boolean;
/**
* Whether to add the smime capibilities to the signature attributes.
*
* @type { ?boolean }
* @default true
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
addSmimeCapAttr?: boolean
}
/**
* CMS generator options.
*
* @typedef CmsGeneratorOptions
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface CmsGeneratorOptions {
/**
* The format of the content data.
*
* @type { ?CmsContentDataFormat }
* @default CmsContentDataFormat.BINARY
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
contentDataFormat?: CmsContentDataFormat;
/**
* The output format of the CMS final data.
*
* @type { ?CmsFormat }
* @default CmsFormat.DER
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
outFormat?: CmsFormat;
/**
* Whether the CMS final data does not contain original content data.
*
* @type { ?boolean }
* @default false
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
isDetached?: boolean;
}
/**
* Provides the interface for generating CMS.
*
* @typedef CmsGenerator
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface CmsGenerator {
/**
* Used to add the signer info.
*
* @param { X509Cert } cert - the signer certificate.
* @param { PrivateKeyInfo } keyInfo - the private key info of the signer certificate.
* @param { CmsSignerConfig } config - the configuration for CMS signer.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030008 - maybe wrong password.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
addSigner(cert: X509Cert, keyInfo: PrivateKeyInfo, config: CmsSignerConfig): void;
/**
* Used to add the certificate, such as the issuer certificate of the signer certificate.
*
* @param { X509Cert } cert - the certificate.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
addCert(cert: X509Cert): void;
/**
* Used to obtain the CMS final data, such as CMS signed data.
*
* @param { Uint8Array } data - the content data for CMS operation.
* @param { CmsGeneratorOptions } [options] - the configuration options for CMS operation.
* @returns { Promise<Uint8Array | string> } the promise returned by the function.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
doFinal(data: Uint8Array, options?: CmsGeneratorOptions): Promise<Uint8Array | string>;
/**
* Used to obtain the CMS final data, such as CMS signed data.
*
* @param { Uint8Array } data - the content data for CMS operation.
* @param { CmsGeneratorOptions } [options] - the configuration options for CMS operation.
* @returns { Uint8Array | string } the CMS final data.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
doFinalSync(data: Uint8Array, options?: CmsGeneratorOptions): Uint8Array | string;
}
/**
* Used to create CmsGenerator.
*
* @param { CmsContentType } contentType - the CMS content type.
* @returns { CmsGenerator } the CmsGenerator.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
function createCmsGenerator(contentType: CmsContentType): CmsGenerator;
/**
* Additional information about the subject of the certificate.
*
* @typedef CsrAttribute
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface CsrAttribute {
/**
* Attribute type.
*
* @type { string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
type: string;
/**
* Attribute value.
*
* @type { string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
value: string;
}
/**
* Configuration for generating a certificate signing request.
*
* @typedef CsrGenerationConfig
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
interface CsrGenerationConfig {
/**
* The subject.
*
* @type { X500DistinguishedName }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
subject: X500DistinguishedName;
/**
* The message digest name, such as "SHA384".
*
* @type { string }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
mdName: string;
/**
* The attributes.
*
* @type { ?Array<CsrAttribute> }
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
attributes?: Array<CsrAttribute>;
/**
* The output format of CSR.
*
* @type { ?EncodingBaseFormat }
* @default EncodingBaseFormat.PEM
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
outFormat?: EncodingBaseFormat;
}
/**
* Used to generate certificate signing request.
*
* @param { PrivateKeyInfo } keyInfo - the private key info.
* @param { CsrGenerationConfig } config - the configuration for generating CSR.
* @returns { string | Uint8Array } the CSR in PEM or DER format.
* @throws { BusinessError } 401 - invalid parameters. Possible causes: 1. Mandatory parameters are left unspecified;
* <br>2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 19020001 - memory malloc failed.
* @throws { BusinessError } 19020002 - runtime error. Possible causes: 1. Memory copy failed;
* <br>2. A null pointer occurs inside the system; 3. Failed to convert parameters between ArkTS and C.
* @throws { BusinessError } 19030001 - crypto operation error.
* @throws { BusinessError } 19030008 - maybe wrong password.
* @syscap SystemCapability.Security.Cert
* @crossplatform
* @atomicservice
* @since 18
*/
function generateCsr(keyInfo: PrivateKeyInfo, config: CsrGenerationConfig): string | Uint8Array;
}
export default cert;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助