1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043 |
- //+---------------------------------------------------------------------------
- //
- // Microsoft Windows
- // Copyright (C) Microsoft Corporation, 1992-1999.
- //
- // File: wincrypt.h
- //
- // Contents: Cryptographic API Prototypes and Definitions
- //
- //----------------------------------------------------------------------------
- #ifndef __WINCRYPT_H__
- #define __WINCRYPT_H__
- #if defined (_MSC_VER)
- #if ( _MSC_VER >= 800 )
- #if _MSC_VER >= 1200
- #pragma warning(push)
- #endif
- #pragma warning(disable:4201) /* Nameless struct/union */
- #endif
- #if (_MSC_VER > 1020)
- #pragma once
- #endif
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- #ifndef _HRESULT_DEFINED
- #define _HRESULT_DEFINED
- typedef LONG HRESULT;
- #endif // !_HRESULT_DEFINED
- #ifndef WINADVAPI
- #define WINADVAPI
- #endif
- #ifndef WINAPI
- #define WINAPI __stdcall
- #endif
- #ifndef CALLBACK
- #define CALLBACK __stdcall
- #endif
- #ifndef DECLSPEC_IMPORT
- #define DECLSPEC_IMPORT
- #endif
- #ifndef CONST
- #define CONST const
- #endif
- #ifndef IN
- #define IN
- #endif
- #ifndef OUT
- #define OUT
- #endif
- #ifndef OPTIONAL
- #define OPTIONAL
- #endif
- #if !defined(_CRYPT32_)
- #define WINCRYPT32API DECLSPEC_IMPORT
- #else
- #define WINCRYPT32API
- #endif
- #if !defined(_CRYPT32STRING_)
- # define WINCRYPT32STRINGAPI WINCRYPT32API
- #else
- # define WINCRYPT32STRINGAPI
- #endif
- //
- // Algorithm IDs and Flags
- //
- // ALG_ID crackers
- #define GET_ALG_CLASS(x) (x & (7 << 13))
- #define GET_ALG_TYPE(x) (x & (15 << 9))
- #define GET_ALG_SID(x) (x & (511))
- // Algorithm classes
- #define ALG_CLASS_ANY (0)
- #define ALG_CLASS_SIGNATURE (1 << 13)
- #define ALG_CLASS_MSG_ENCRYPT (2 << 13)
- #define ALG_CLASS_DATA_ENCRYPT (3 << 13)
- #define ALG_CLASS_HASH (4 << 13)
- #define ALG_CLASS_KEY_EXCHANGE (5 << 13)
- #define ALG_CLASS_ALL (7 << 13)
- // Algorithm types
- #define ALG_TYPE_ANY (0)
- #define ALG_TYPE_DSS (1 << 9)
- #define ALG_TYPE_RSA (2 << 9)
- #define ALG_TYPE_BLOCK (3 << 9)
- #define ALG_TYPE_STREAM (4 << 9)
- #define ALG_TYPE_DH (5 << 9)
- #define ALG_TYPE_SECURECHANNEL (6 << 9)
- // Generic sub-ids
- #define ALG_SID_ANY (0)
- // Some RSA sub-ids
- #define ALG_SID_RSA_ANY 0
- #define ALG_SID_RSA_PKCS 1
- #define ALG_SID_RSA_MSATWORK 2
- #define ALG_SID_RSA_ENTRUST 3
- #define ALG_SID_RSA_PGP 4
- // Some DSS sub-ids
- //
- #define ALG_SID_DSS_ANY 0
- #define ALG_SID_DSS_PKCS 1
- #define ALG_SID_DSS_DMS 2
- // Block cipher sub ids
- // DES sub_ids
- #define ALG_SID_DES 1
- #define ALG_SID_3DES 3
- #define ALG_SID_DESX 4
- #define ALG_SID_IDEA 5
- #define ALG_SID_CAST 6
- #define ALG_SID_SAFERSK64 7
- #define ALG_SID_SAFERSK128 8
- #define ALG_SID_3DES_112 9
- #define ALG_SID_CYLINK_MEK 12
- #define ALG_SID_RC5 13
- #define ALG_SID_AES_128 14
- #define ALG_SID_AES_192 15
- #define ALG_SID_AES_256 16
- #define ALG_SID_AES 17
- // Fortezza sub-ids
- #define ALG_SID_SKIPJACK 10
- #define ALG_SID_TEK 11
- // KP_MODE
- #define CRYPT_MODE_CBCI 6 // ANSI CBC Interleaved
- #define CRYPT_MODE_CFBP 7 // ANSI CFB Pipelined
- #define CRYPT_MODE_OFBP 8 // ANSI OFB Pipelined
- #define CRYPT_MODE_CBCOFM 9 // ANSI CBC + OF Masking
- #define CRYPT_MODE_CBCOFMI 10 // ANSI CBC + OFM Interleaved
- // RC2 sub-ids
- #define ALG_SID_RC2 2
- // Stream cipher sub-ids
- #define ALG_SID_RC4 1
- #define ALG_SID_SEAL 2
- // Diffie-Hellman sub-ids
- #define ALG_SID_DH_SANDF 1
- #define ALG_SID_DH_EPHEM 2
- #define ALG_SID_AGREED_KEY_ANY 3
- #define ALG_SID_KEA 4
- // Hash sub ids
- #define ALG_SID_MD2 1
- #define ALG_SID_MD4 2
- #define ALG_SID_MD5 3
- #define ALG_SID_SHA 4
- #define ALG_SID_SHA1 4
- #define ALG_SID_MAC 5
- #define ALG_SID_RIPEMD 6
- #define ALG_SID_RIPEMD160 7
- #define ALG_SID_SSL3SHAMD5 8
- #define ALG_SID_HMAC 9
- #define ALG_SID_TLS1PRF 10
- #define ALG_SID_HASH_REPLACE_OWF 11
- // secure channel sub ids
- #define ALG_SID_SSL3_MASTER 1
- #define ALG_SID_SCHANNEL_MASTER_HASH 2
- #define ALG_SID_SCHANNEL_MAC_KEY 3
- #define ALG_SID_PCT1_MASTER 4
- #define ALG_SID_SSL2_MASTER 5
- #define ALG_SID_TLS1_MASTER 6
- #define ALG_SID_SCHANNEL_ENC_KEY 7
- // Our silly example sub-id
- #define ALG_SID_EXAMPLE 80
- #ifndef ALGIDDEF
- #define ALGIDDEF
- typedef unsigned int ALG_ID;
- #endif
- // algorithm identifier definitions
- #define CALG_MD2 (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD2)
- #define CALG_MD4 (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD4)
- #define CALG_MD5 (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD5)
- #define CALG_SHA (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA)
- #define CALG_SHA1 (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA1)
- #define CALG_MAC (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MAC)
- #define CALG_RSA_SIGN (ALG_CLASS_SIGNATURE | ALG_TYPE_RSA | ALG_SID_RSA_ANY)
- #define CALG_DSS_SIGN (ALG_CLASS_SIGNATURE | ALG_TYPE_DSS | ALG_SID_DSS_ANY)
- #define CALG_NO_SIGN (ALG_CLASS_SIGNATURE | ALG_TYPE_ANY | ALG_SID_ANY)
- #define CALG_RSA_KEYX (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_RSA|ALG_SID_RSA_ANY)
- #define CALG_DES (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_DES)
- #define CALG_3DES_112 (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_3DES_112)
- #define CALG_3DES (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_3DES)
- #define CALG_DESX (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_DESX)
- #define CALG_RC2 (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_RC2)
- #define CALG_RC4 (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_STREAM|ALG_SID_RC4)
- #define CALG_SEAL (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_STREAM|ALG_SID_SEAL)
- #define CALG_DH_SF (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_DH_SANDF)
- #define CALG_DH_EPHEM (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_DH_EPHEM)
- #define CALG_AGREEDKEY_ANY (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_AGREED_KEY_ANY)
- #define CALG_KEA_KEYX (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_KEA)
- #define CALG_HUGHES_MD5 (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_ANY|ALG_SID_MD5)
- #define CALG_SKIPJACK (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_SKIPJACK)
- #define CALG_TEK (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_TEK)
- #define CALG_CYLINK_MEK (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_CYLINK_MEK)
- #define CALG_SSL3_SHAMD5 (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SSL3SHAMD5)
- #define CALG_SSL3_MASTER (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SSL3_MASTER)
- #define CALG_SCHANNEL_MASTER_HASH (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_MASTER_HASH)
- #define CALG_SCHANNEL_MAC_KEY (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_MAC_KEY)
- #define CALG_SCHANNEL_ENC_KEY (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_ENC_KEY)
- #define CALG_PCT1_MASTER (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_PCT1_MASTER)
- #define CALG_SSL2_MASTER (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SSL2_MASTER)
- #define CALG_TLS1_MASTER (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_TLS1_MASTER)
- #define CALG_RC5 (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_RC5)
- #define CALG_HMAC (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HMAC)
- #define CALG_TLS1PRF (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_TLS1PRF)
- #define CALG_HASH_REPLACE_OWF (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HASH_REPLACE_OWF)
- #define CALG_AES_128 (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_128)
- #define CALG_AES_192 (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_192)
- #define CALG_AES_256 (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_256)
- #define CALG_AES (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES)
- typedef ULONG_PTR HCRYPTPROV;
- typedef ULONG_PTR HCRYPTKEY;
- typedef ULONG_PTR HCRYPTHASH;
- // dwFlags definitions for CryptAcquireContext
- #define CRYPT_VERIFYCONTEXT 0xF0000000
- #define CRYPT_NEWKEYSET 0x00000008
- #define CRYPT_DELETEKEYSET 0x00000010
- #define CRYPT_MACHINE_KEYSET 0x00000020
- #define CRYPT_SILENT 0x00000040
- // dwFlag definitions for CryptGenKey
- #define CRYPT_EXPORTABLE 0x00000001
- #define CRYPT_USER_PROTECTED 0x00000002
- #define CRYPT_CREATE_SALT 0x00000004
- #define CRYPT_UPDATE_KEY 0x00000008
- #define CRYPT_NO_SALT 0x00000010
- #define CRYPT_PREGEN 0x00000040
- #define CRYPT_RECIPIENT 0x00000010
- #define CRYPT_INITIATOR 0x00000040
- #define CRYPT_ONLINE 0x00000080
- #define CRYPT_SF 0x00000100
- #define CRYPT_CREATE_IV 0x00000200
- #define CRYPT_KEK 0x00000400
- #define CRYPT_DATA_KEY 0x00000800
- #define CRYPT_VOLATILE 0x00001000
- #define CRYPT_SGCKEY 0x00002000
- #define CRYPT_ARCHIVABLE 0x00004000
- #define RSA1024BIT_KEY 0x04000000
- // dwFlags definitions for CryptDeriveKey
- #define CRYPT_SERVER 0x00000400
- #define KEY_LENGTH_MASK 0xFFFF0000
- // dwFlag definitions for CryptExportKey
- #define CRYPT_Y_ONLY 0x00000001
- #define CRYPT_SSL2_FALLBACK 0x00000002
- #define CRYPT_DESTROYKEY 0x00000004
- #define CRYPT_OAEP 0x00000040 // used with RSA encryptions/decryptions
- // CryptExportKey, CryptImportKey,
- // CryptEncrypt and CryptDecrypt
- #define CRYPT_BLOB_VER3 0x00000080 // export version 3 of a blob type
- #define CRYPT_IPSEC_HMAC_KEY 0x00000100 // CryptImportKey only
- // dwFlags definitions for CryptCreateHash
- #define CRYPT_SECRETDIGEST 0x00000001
- // dwFlags definitions for CryptHashData
- #define CRYPT_OWF_REPL_LM_HASH 0x00000001 // this is only for the OWF replacement CSP
- // dwFlags definitions for CryptHashSessionKey
- #define CRYPT_LITTLE_ENDIAN 0x00000001
- // dwFlags definitions for CryptSignHash and CryptVerifySignature
- #define CRYPT_NOHASHOID 0x00000001
- #define CRYPT_TYPE2_FORMAT 0x00000002
- #define CRYPT_X931_FORMAT 0x00000004
- // dwFlag definitions for CryptSetProviderEx and CryptGetDefaultProvider
- #define CRYPT_MACHINE_DEFAULT 0x00000001
- #define CRYPT_USER_DEFAULT 0x00000002
- #define CRYPT_DELETE_DEFAULT 0x00000004
- // exported key blob definitions
- #define SIMPLEBLOB 0x1
- #define PUBLICKEYBLOB 0x6
- #define PRIVATEKEYBLOB 0x7
- #define PLAINTEXTKEYBLOB 0x8
- #define OPAQUEKEYBLOB 0x9
- #define PUBLICKEYBLOBEX 0xA
- #define SYMMETRICWRAPKEYBLOB 0xB
- #define AT_KEYEXCHANGE 1
- #define AT_SIGNATURE 2
- #define CRYPT_USERDATA 1
- // dwParam
- #define KP_IV 1 // Initialization vector
- #define KP_SALT 2 // Salt value
- #define KP_PADDING 3 // Padding values
- #define KP_MODE 4 // Mode of the cipher
- #define KP_MODE_BITS 5 // Number of bits to feedback
- #define KP_PERMISSIONS 6 // Key permissions DWORD
- #define KP_ALGID 7 // Key algorithm
- #define KP_BLOCKLEN 8 // Block size of the cipher
- #define KP_KEYLEN 9 // Length of key in bits
- #define KP_SALT_EX 10 // Length of salt in bytes
- #define KP_P 11 // DSS/Diffie-Hellman P value
- #define KP_G 12 // DSS/Diffie-Hellman G value
- #define KP_Q 13 // DSS Q value
- #define KP_X 14 // Diffie-Hellman X value
- #define KP_Y 15 // Y value
- #define KP_RA 16 // Fortezza RA value
- #define KP_RB 17 // Fortezza RB value
- #define KP_INFO 18 // for putting information into an RSA envelope
- #define KP_EFFECTIVE_KEYLEN 19 // setting and getting RC2 effective key length
- #define KP_SCHANNEL_ALG 20 // for setting the Secure Channel algorithms
- #define KP_CLIENT_RANDOM 21 // for setting the Secure Channel client random data
- #define KP_SERVER_RANDOM 22 // for setting the Secure Channel server random data
- #define KP_RP 23
- #define KP_PRECOMP_MD5 24
- #define KP_PRECOMP_SHA 25
- #define KP_CERTIFICATE 26 // for setting Secure Channel certificate data (PCT1)
- #define KP_CLEAR_KEY 27 // for setting Secure Channel clear key data (PCT1)
- #define KP_PUB_EX_LEN 28
- #define KP_PUB_EX_VAL 29
- #define KP_KEYVAL 30
- #define KP_ADMIN_PIN 31
- #define KP_KEYEXCHANGE_PIN 32
- #define KP_SIGNATURE_PIN 33
- #define KP_PREHASH 34
- #define KP_OAEP_PARAMS 36 // for setting OAEP params on RSA keys
- #define KP_CMS_KEY_INFO 37
- #define KP_CMS_DH_KEY_INFO 38
- #define KP_PUB_PARAMS 39 // for setting public parameters
- #define KP_VERIFY_PARAMS 40 // for verifying DSA and DH parameters
- #define KP_HIGHEST_VERSION 41 // for TLS protocol version setting
- // KP_PADDING
- #define PKCS5_PADDING 1 // PKCS 5 (sec 6.2) padding method
- #define RANDOM_PADDING 2
- #define ZERO_PADDING 3
- // KP_MODE
- #define CRYPT_MODE_CBC 1 // Cipher block chaining
- #define CRYPT_MODE_ECB 2 // Electronic code book
- #define CRYPT_MODE_OFB 3 // Output feedback mode
- #define CRYPT_MODE_CFB 4 // Cipher feedback mode
- #define CRYPT_MODE_CTS 5 // Ciphertext stealing mode
- // KP_PERMISSIONS
- #define CRYPT_ENCRYPT 0x0001 // Allow encryption
- #define CRYPT_DECRYPT 0x0002 // Allow decryption
- #define CRYPT_EXPORT 0x0004 // Allow key to be exported
- #define CRYPT_READ 0x0008 // Allow parameters to be read
- #define CRYPT_WRITE 0x0010 // Allow parameters to be set
- #define CRYPT_MAC 0x0020 // Allow MACs to be used with key
- #define CRYPT_EXPORT_KEY 0x0040 // Allow key to be used for exporting keys
- #define CRYPT_IMPORT_KEY 0x0080 // Allow key to be used for importing keys
- #define CRYPT_ARCHIVE 0x0100 // Allow key to be exported at creation only
- #define HP_ALGID 0x0001 // Hash algorithm
- #define HP_HASHVAL 0x0002 // Hash value
- #define HP_HASHSIZE 0x0004 // Hash value size
- #define HP_HMAC_INFO 0x0005 // information for creating an HMAC
- #define HP_TLS1PRF_LABEL 0x0006 // label for TLS1 PRF
- #define HP_TLS1PRF_SEED 0x0007 // seed for TLS1 PRF
- #define CRYPT_FAILED FALSE
- #define CRYPT_SUCCEED TRUE
- #define RCRYPT_SUCCEEDED(rt) ((rt) == CRYPT_SUCCEED)
- #define RCRYPT_FAILED(rt) ((rt) == CRYPT_FAILED)
- //
- // CryptGetProvParam
- //
- #define PP_ENUMALGS 1
- #define PP_ENUMCONTAINERS 2
- #define PP_IMPTYPE 3
- #define PP_NAME 4
- #define PP_VERSION 5
- #define PP_CONTAINER 6
- #define PP_CHANGE_PASSWORD 7
- #define PP_KEYSET_SEC_DESCR 8 // get/set security descriptor of keyset
- #define PP_CERTCHAIN 9 // for retrieving certificates from tokens
- #define PP_KEY_TYPE_SUBTYPE 10
- #define PP_PROVTYPE 16
- #define PP_KEYSTORAGE 17
- #define PP_APPLI_CERT 18
- #define PP_SYM_KEYSIZE 19
- #define PP_SESSION_KEYSIZE 20
- #define PP_UI_PROMPT 21
- #define PP_ENUMALGS_EX 22
- #define PP_ENUMMANDROOTS 25
- #define PP_ENUMELECTROOTS 26
- #define PP_KEYSET_TYPE 27
- #define PP_ADMIN_PIN 31
- #define PP_KEYEXCHANGE_PIN 32
- #define PP_SIGNATURE_PIN 33
- #define PP_SIG_KEYSIZE_INC 34
- #define PP_KEYX_KEYSIZE_INC 35
- #define PP_UNIQUE_CONTAINER 36
- #define PP_SGC_INFO 37
- #define PP_USE_HARDWARE_RNG 38
- #define PP_KEYSPEC 39
- #define PP_ENUMEX_SIGNING_PROT 40
- #define CRYPT_FIRST 1
- #define CRYPT_NEXT 2
- #define CRYPT_SGC_ENUM 4
- #define CRYPT_IMPL_HARDWARE 1
- #define CRYPT_IMPL_SOFTWARE 2
- #define CRYPT_IMPL_MIXED 3
- #define CRYPT_IMPL_UNKNOWN 4
- #define CRYPT_IMPL_REMOVABLE 8
- // key storage flags
- #define CRYPT_SEC_DESCR 0x00000001
- #define CRYPT_PSTORE 0x00000002
- #define CRYPT_UI_PROMPT 0x00000004
- // protocol flags
- #define CRYPT_FLAG_PCT1 0x0001
- #define CRYPT_FLAG_SSL2 0x0002
- #define CRYPT_FLAG_SSL3 0x0004
- #define CRYPT_FLAG_TLS1 0x0008
- #define CRYPT_FLAG_IPSEC 0x0010
- #define CRYPT_FLAG_SIGNING 0x0020
- // SGC flags
- #define CRYPT_SGC 0x0001
- #define CRYPT_FASTSGC 0x0002
- //
- // CryptSetProvParam
- //
- #define PP_CLIENT_HWND 1
- #define PP_CONTEXT_INFO 11
- #define PP_KEYEXCHANGE_KEYSIZE 12
- #define PP_SIGNATURE_KEYSIZE 13
- #define PP_KEYEXCHANGE_ALG 14
- #define PP_SIGNATURE_ALG 15
- #define PP_DELETEKEY 24
- #define PROV_RSA_FULL 1
- #define PROV_RSA_SIG 2
- #define PROV_DSS 3
- #define PROV_FORTEZZA 4
- #define PROV_MS_EXCHANGE 5
- #define PROV_SSL 6
- #define PROV_RSA_SCHANNEL 12
- #define PROV_DSS_DH 13
- #define PROV_EC_ECDSA_SIG 14
- #define PROV_EC_ECNRA_SIG 15
- #define PROV_EC_ECDSA_FULL 16
- #define PROV_EC_ECNRA_FULL 17
- #define PROV_DH_SCHANNEL 18
- #define PROV_SPYRUS_LYNKS 20
- #define PROV_RNG 21
- #define PROV_INTEL_SEC 22
- #define PROV_REPLACE_OWF 23
- #define PROV_RSA_AES 24
- //
- // STT defined Providers
- //
- #define PROV_STT_MER 7
- #define PROV_STT_ACQ 8
- #define PROV_STT_BRND 9
- #define PROV_STT_ROOT 10
- #define PROV_STT_ISS 11
- //
- // Provider friendly names
- //
- #define MS_DEF_PROV_A "Microsoft Base Cryptographic Provider v1.0"
- #define MS_DEF_PROV_W L"Microsoft Base Cryptographic Provider v1.0"
- #ifdef UNICODE
- #define MS_DEF_PROV MS_DEF_PROV_W
- #else
- #define MS_DEF_PROV MS_DEF_PROV_A
- #endif
- #define MS_ENHANCED_PROV_A "Microsoft Enhanced Cryptographic Provider v1.0"
- #define MS_ENHANCED_PROV_W L"Microsoft Enhanced Cryptographic Provider v1.0"
- #ifdef UNICODE
- #define MS_ENHANCED_PROV MS_ENHANCED_PROV_W
- #else
- #define MS_ENHANCED_PROV MS_ENHANCED_PROV_A
- #endif
- #define MS_STRONG_PROV_A "Microsoft Strong Cryptographic Provider"
- #define MS_STRONG_PROV_W L"Microsoft Strong Cryptographic Provider"
- #ifdef UNICODE
- #define MS_STRONG_PROV MS_STRONG_PROV_W
- #else
- #define MS_STRONG_PROV MS_STRONG_PROV_A
- #endif
- #define MS_DEF_RSA_SIG_PROV_A "Microsoft RSA Signature Cryptographic Provider"
- #define MS_DEF_RSA_SIG_PROV_W L"Microsoft RSA Signature Cryptographic Provider"
- #ifdef UNICODE
- #define MS_DEF_RSA_SIG_PROV MS_DEF_RSA_SIG_PROV_W
- #else
- #define MS_DEF_RSA_SIG_PROV MS_DEF_RSA_SIG_PROV_A
- #endif
- #define MS_DEF_RSA_SCHANNEL_PROV_A "Microsoft RSA SChannel Cryptographic Provider"
- #define MS_DEF_RSA_SCHANNEL_PROV_W L"Microsoft RSA SChannel Cryptographic Provider"
- #ifdef UNICODE
- #define MS_DEF_RSA_SCHANNEL_PROV MS_DEF_RSA_SCHANNEL_PROV_W
- #else
- #define MS_DEF_RSA_SCHANNEL_PROV MS_DEF_RSA_SCHANNEL_PROV_A
- #endif
- #define MS_DEF_DSS_PROV_A "Microsoft Base DSS Cryptographic Provider"
- #define MS_DEF_DSS_PROV_W L"Microsoft Base DSS Cryptographic Provider"
- #ifdef UNICODE
- #define MS_DEF_DSS_PROV MS_DEF_DSS_PROV_W
- #else
- #define MS_DEF_DSS_PROV MS_DEF_DSS_PROV_A
- #endif
- #define MS_DEF_DSS_DH_PROV_A "Microsoft Base DSS and Diffie-Hellman Cryptographic Provider"
- #define MS_DEF_DSS_DH_PROV_W L"Microsoft Base DSS and Diffie-Hellman Cryptographic Provider"
- #ifdef UNICODE
- #define MS_DEF_DSS_DH_PROV MS_DEF_DSS_DH_PROV_W
- #else
- #define MS_DEF_DSS_DH_PROV MS_DEF_DSS_DH_PROV_A
- #endif
- #define MS_ENH_DSS_DH_PROV_A "Microsoft Enhanced DSS and Diffie-Hellman Cryptographic Provider"
- #define MS_ENH_DSS_DH_PROV_W L"Microsoft Enhanced DSS and Diffie-Hellman Cryptographic Provider"
- #ifdef UNICODE
- #define MS_ENH_DSS_DH_PROV MS_ENH_DSS_DH_PROV_W
- #else
- #define MS_ENH_DSS_DH_PROV MS_ENH_DSS_DH_PROV_A
- #endif
- #define MS_DEF_DH_SCHANNEL_PROV_A "Microsoft DH SChannel Cryptographic Provider"
- #define MS_DEF_DH_SCHANNEL_PROV_W L"Microsoft DH SChannel Cryptographic Provider"
- #ifdef UNICODE
- #define MS_DEF_DH_SCHANNEL_PROV MS_DEF_DH_SCHANNEL_PROV_W
- #else
- #define MS_DEF_DH_SCHANNEL_PROV MS_DEF_DH_SCHANNEL_PROV_A
- #endif
- #define MS_SCARD_PROV_A "Microsoft Base Smart Card Crypto Provider"
- #define MS_SCARD_PROV_W L"Microsoft Base Smart Card Crypto Provider"
- #ifdef UNICODE
- #define MS_SCARD_PROV MS_SCARD_PROV_W
- #else
- #define MS_SCARD_PROV MS_SCARD_PROV_A
- #endif
- #define MS_ENH_RSA_AES_PROV_A "Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype)"
- #define MS_ENH_RSA_AES_PROV_W L"Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype)"
- #ifdef UNICODE
- #define MS_ENH_RSA_AES_PROV MS_ENH_RSA_AES_PROV_W
- #else
- #define MS_ENH_RSA_AES_PROV MS_ENH_RSA_AES_PROV_A
- #endif
- #define MAXUIDLEN 64
- // Exponentiation Offload Reg Location
- #define EXPO_OFFLOAD_REG_VALUE "ExpoOffload"
- #define EXPO_OFFLOAD_FUNC_NAME "OffloadModExpo"
- //
- // Registry key in which the following private key-related
- // values are created.
- //
- #define szKEY_CRYPTOAPI_PRIVATE_KEY_OPTIONS \
- "Software\\Policies\\Microsoft\\Cryptography"
- //
- // Registry value for controlling Data Protection API (DPAPI) UI settings.
- //
- #define szFORCE_KEY_PROTECTION "ForceKeyProtection"
- #define dwFORCE_KEY_PROTECTION_DISABLED 0x0
- #define dwFORCE_KEY_PROTECTION_USER_SELECT 0x1
- #define dwFORCE_KEY_PROTECTION_HIGH 0x2
- //
- // Registry values for enabling and controlling the caching (and timeout)
- // of private keys. This feature is useful only for UI-protected private
- // of private keys. This feature is intended for UI-protected private
- // keys.
- //
- // Note that in Windows 2000 and later, private keys, once read from storage,
- // are cached in the associated HCRYPTPROV structure for subsequent use.
- //
- // In .NET Server and XP SP1, new key caching behavior is available. Keys
- // In Server 2003 and XP SP1, new key caching behavior is available. Keys
- // that have been read from storage and cached may now be considered "stale"
- // if a period of time has elapsed since the key was last used. This forces
- // the key to be re-read from storage (which will make the DPAPI UI appear
- // again).
- //
- // Optional Key Timeouts:
- //
- // In Windows Server 2003, XP SP1, and later, new key caching behavior is
- // available. Keys that have been read from storage and cached per-context
- // may now be considered "stale" if a period of time has elapsed since the
- // key was last used. This forces the key to be re-read from storage (which
- // will make the Data Protection API dialog appear again if the key is
- // UI-protected).
- //
- // To enable the new behavior, create the registry DWORD value
- // szKEY_CACHE_ENABLED and set it to 1. The registry DWORD value
- // szKEY_CACHE_SECONDS must also be created and set to the number of seconds
- // that a cached private key may still be considered usable.
- //
- #define szKEY_CACHE_ENABLED "CachePrivateKeys"
- #define szKEY_CACHE_SECONDS "PrivateKeyLifetimeSeconds"
- //
- // In platforms later than (and not including) Windows Server 2003, including
- // XP SP2, private keys are always cached for a period of time per-process,
- // even when not being used in any context.
- //
- // The differences between the process-wide caching settings described below
- // and the Optional Key Timeouts described above are subtle.
- //
- // - The Optional Key Timeout policy is applied only when an attempt is made
- // to use a specific private key with an open context handle (HCRYPTPROV).
- // If szKEY_CACHE_SECONDS have elapsed since the key was last used, the
- // private key will be re-read from storage.
- //
- // - The Cache Purge Interval policy, below, is applied whenever any
- // non-ephemeral private key is used or read from storage. If
- // szPRIV_KEY_CACHE_PURGE_INTERVAL_SECONDS have elapsed since the last
- // purge occurred, all cached keys that have not been referenced since the
- // last purge will be removed from the cache.
- //
- // If a private key that is purged from the cache is currently
- // referenced in an open context, then the key will be re-read from storage
- // the next time an attempt is made to use it (via any context).
- //
- // The following two registry DWORD values control this behavior.
- //
- //
- // Registry value for controlling the maximum number of persisted
- // (non-ephemeral) private keys that can be cached per-process. If the cache
- // fills up, keys will be replaced on a least-recently-used basis. If the
- // maximum number of cached keys is set to zero, no keys will be globally
- // cached.
- //
- #define szPRIV_KEY_CACHE_MAX_ITEMS "PrivKeyCacheMaxItems"
- #define cPRIV_KEY_CACHE_MAX_ITEMS_DEFAULT 20
- //
- // Registry value for controlling the interval at which the private key
- // cache is proactively purged of outdated keys.
- //
- #define szPRIV_KEY_CACHE_PURGE_INTERVAL_SECONDS "PrivKeyCachePurgeIntervalSeconds"
- #define cPRIV_KEY_CACHE_PURGE_INTERVAL_SECONDS_DEFAULT 86400 // 1 day
- #define CUR_BLOB_VERSION 2
- // structure for use with CryptSetKeyParam for CMS keys
- // DO NOT USE THIS STRUCTURE!!!!!
- typedef struct _CMS_KEY_INFO {
- DWORD dwVersion; // sizeof(CMS_KEY_INFO)
- ALG_ID Algid; // algorithmm id for the key to be converted
- BYTE *pbOID; // pointer to OID to hash in with Z
- DWORD cbOID; // length of OID to hash in with Z
- } CMS_KEY_INFO, *PCMS_KEY_INFO;
- // structure for use with CryptSetHashParam with CALG_HMAC
- typedef struct _HMAC_Info {
- ALG_ID HashAlgid;
- BYTE *pbInnerString;
- DWORD cbInnerString;
- BYTE *pbOuterString;
- DWORD cbOuterString;
- } HMAC_INFO, *PHMAC_INFO;
- // structure for use with CryptSetKeyParam with KP_SCHANNEL_ALG
- typedef struct _SCHANNEL_ALG {
- DWORD dwUse;
- ALG_ID Algid;
- DWORD cBits;
- DWORD dwFlags;
- DWORD dwReserved;
- } SCHANNEL_ALG, *PSCHANNEL_ALG;
- // uses of algortihms for SCHANNEL_ALG structure
- #define SCHANNEL_MAC_KEY 0x00000000
- #define SCHANNEL_ENC_KEY 0x00000001
- // uses of dwFlags SCHANNEL_ALG structure
- #define INTERNATIONAL_USAGE 0x00000001
- typedef struct _PROV_ENUMALGS {
- ALG_ID aiAlgid;
- DWORD dwBitLen;
- DWORD dwNameLen;
- CHAR szName[20];
- } PROV_ENUMALGS;
- typedef struct _PROV_ENUMALGS_EX {
- ALG_ID aiAlgid;
- DWORD dwDefaultLen;
- DWORD dwMinLen;
- DWORD dwMaxLen;
- DWORD dwProtocols;
- DWORD dwNameLen;
- CHAR szName[20];
- DWORD dwLongNameLen;
- CHAR szLongName[40];
- } PROV_ENUMALGS_EX;
- typedef struct _PUBLICKEYSTRUC {
- BYTE bType;
- BYTE bVersion;
- WORD reserved;
- ALG_ID aiKeyAlg;
- } BLOBHEADER, PUBLICKEYSTRUC;
- typedef struct _RSAPUBKEY {
- DWORD magic; // Has to be RSA1
- DWORD bitlen; // # of bits in modulus
- DWORD pubexp; // public exponent
- // Modulus data follows
- } RSAPUBKEY;
- typedef struct _PUBKEY {
- DWORD magic;
- DWORD bitlen; // # of bits in modulus
- } DHPUBKEY, DSSPUBKEY, KEAPUBKEY, TEKPUBKEY;
- typedef struct _DSSSEED {
- DWORD counter;
- BYTE seed[20];
- } DSSSEED;
- typedef struct _PUBKEYVER3 {
- DWORD magic;
- DWORD bitlenP; // # of bits in prime modulus
- DWORD bitlenQ; // # of bits in prime q, 0 if not available
- DWORD bitlenJ; // # of bits in (p-1)/q, 0 if not available
- DSSSEED DSSSeed;
- } DHPUBKEY_VER3, DSSPUBKEY_VER3;
- typedef struct _PRIVKEYVER3 {
- DWORD magic;
- DWORD bitlenP; // # of bits in prime modulus
- DWORD bitlenQ; // # of bits in prime q, 0 if not available
- DWORD bitlenJ; // # of bits in (p-1)/q, 0 if not available
- DWORD bitlenX; // # of bits in X
- DSSSEED DSSSeed;
- } DHPRIVKEY_VER3, DSSPRIVKEY_VER3;
- typedef struct _KEY_TYPE_SUBTYPE {
- DWORD dwKeySpec;
- GUID Type;
- GUID Subtype;
- } KEY_TYPE_SUBTYPE, *PKEY_TYPE_SUBTYPE;
- typedef struct _CERT_FORTEZZA_DATA_PROP {
- unsigned char SerialNumber[8];
- int CertIndex;
- unsigned char CertLabel[36];
- } CERT_FORTEZZA_DATA_PROP;
- //+-------------------------------------------------------------------------
- // CRYPTOAPI BLOB definitions
- //--------------------------------------------------------------------------
- typedef struct _CRYPTOAPI_BLOB {
- DWORD cbData;
- BYTE *pbData;
- } CRYPT_INTEGER_BLOB, *PCRYPT_INTEGER_BLOB,
- CRYPT_UINT_BLOB, *PCRYPT_UINT_BLOB,
- CRYPT_OBJID_BLOB, *PCRYPT_OBJID_BLOB,
- CERT_NAME_BLOB, *PCERT_NAME_BLOB,
- CERT_RDN_VALUE_BLOB, *PCERT_RDN_VALUE_BLOB,
- CERT_BLOB, *PCERT_BLOB,
- CRL_BLOB, *PCRL_BLOB,
- DATA_BLOB, *PDATA_BLOB,
- CRYPT_DATA_BLOB, *PCRYPT_DATA_BLOB,
- CRYPT_HASH_BLOB, *PCRYPT_HASH_BLOB,
- CRYPT_DIGEST_BLOB, *PCRYPT_DIGEST_BLOB,
- CRYPT_DER_BLOB, *PCRYPT_DER_BLOB,
- CRYPT_ATTR_BLOB, *PCRYPT_ATTR_BLOB;
- // structure for use with CryptSetKeyParam for CMS keys
- typedef struct _CMS_DH_KEY_INFO {
- DWORD dwVersion; // sizeof(CMS_DH_KEY_INFO)
- ALG_ID Algid; // algorithmm id for the key to be converted
- LPSTR pszContentEncObjId; // pointer to OID to hash in with Z
- CRYPT_DATA_BLOB PubInfo; // OPTIONAL - public information
- void *pReserved; // reserved - should be NULL
- } CMS_DH_KEY_INFO, *PCMS_DH_KEY_INFO;
- WINADVAPI
- BOOL
- WINAPI
- CryptAcquireContextA(
- HCRYPTPROV *phProv,
- LPCSTR szContainer,
- LPCSTR szProvider,
- DWORD dwProvType,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptAcquireContextW(
- HCRYPTPROV *phProv,
- LPCWSTR szContainer,
- LPCWSTR szProvider,
- DWORD dwProvType,
- DWORD dwFlags
- );
- #ifdef UNICODE
- #define CryptAcquireContext CryptAcquireContextW
- #else
- #define CryptAcquireContext CryptAcquireContextA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptReleaseContext(
- HCRYPTPROV hProv,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptGenKey(
- HCRYPTPROV hProv,
- ALG_ID Algid,
- DWORD dwFlags,
- HCRYPTKEY *phKey
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptDeriveKey(
- HCRYPTPROV hProv,
- ALG_ID Algid,
- HCRYPTHASH hBaseData,
- DWORD dwFlags,
- HCRYPTKEY *phKey
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptDestroyKey(
- HCRYPTKEY hKey
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptSetKeyParam(
- HCRYPTKEY hKey,
- DWORD dwParam,
- CONST BYTE *pbData,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptGetKeyParam(
- HCRYPTKEY hKey,
- DWORD dwParam,
- BYTE *pbData,
- DWORD *pdwDataLen,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptSetHashParam(
- HCRYPTHASH hHash,
- DWORD dwParam,
- CONST BYTE *pbData,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptGetHashParam(
- HCRYPTHASH hHash,
- DWORD dwParam,
- BYTE *pbData,
- DWORD *pdwDataLen,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptSetProvParam(
- HCRYPTPROV hProv,
- DWORD dwParam,
- CONST BYTE *pbData,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptGetProvParam(
- HCRYPTPROV hProv,
- DWORD dwParam,
- BYTE *pbData,
- DWORD *pdwDataLen,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptGenRandom(
- HCRYPTPROV hProv,
- DWORD dwLen,
- BYTE *pbBuffer
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptGetUserKey(
- HCRYPTPROV hProv,
- DWORD dwKeySpec,
- HCRYPTKEY *phUserKey
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptExportKey(
- HCRYPTKEY hKey,
- HCRYPTKEY hExpKey,
- DWORD dwBlobType,
- DWORD dwFlags,
- BYTE *pbData,
- DWORD *pdwDataLen
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptImportKey(
- HCRYPTPROV hProv,
- CONST BYTE *pbData,
- DWORD dwDataLen,
- HCRYPTKEY hPubKey,
- DWORD dwFlags,
- HCRYPTKEY *phKey
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptEncrypt(
- HCRYPTKEY hKey,
- HCRYPTHASH hHash,
- BOOL Final,
- DWORD dwFlags,
- BYTE *pbData,
- DWORD *pdwDataLen,
- DWORD dwBufLen
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptDecrypt(
- HCRYPTKEY hKey,
- HCRYPTHASH hHash,
- BOOL Final,
- DWORD dwFlags,
- BYTE *pbData,
- DWORD *pdwDataLen
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptCreateHash(
- HCRYPTPROV hProv,
- ALG_ID Algid,
- HCRYPTKEY hKey,
- DWORD dwFlags,
- HCRYPTHASH *phHash
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptHashData(
- HCRYPTHASH hHash,
- CONST BYTE *pbData,
- DWORD dwDataLen,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptHashSessionKey(
- HCRYPTHASH hHash,
- HCRYPTKEY hKey,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptDestroyHash(
- HCRYPTHASH hHash
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptSignHashA(
- HCRYPTHASH hHash,
- DWORD dwKeySpec,
- LPCSTR szDescription,
- DWORD dwFlags,
- BYTE *pbSignature,
- DWORD *pdwSigLen
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptSignHashW(
- HCRYPTHASH hHash,
- DWORD dwKeySpec,
- LPCWSTR szDescription,
- DWORD dwFlags,
- BYTE *pbSignature,
- DWORD *pdwSigLen
- );
- #ifdef UNICODE
- #define CryptSignHash CryptSignHashW
- #else
- #define CryptSignHash CryptSignHashA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptVerifySignatureA(
- HCRYPTHASH hHash,
- CONST BYTE *pbSignature,
- DWORD dwSigLen,
- HCRYPTKEY hPubKey,
- LPCSTR szDescription,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptVerifySignatureW(
- HCRYPTHASH hHash,
- CONST BYTE *pbSignature,
- DWORD dwSigLen,
- HCRYPTKEY hPubKey,
- LPCWSTR szDescription,
- DWORD dwFlags
- );
- #ifdef UNICODE
- #define CryptVerifySignature CryptVerifySignatureW
- #else
- #define CryptVerifySignature CryptVerifySignatureA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptSetProviderA(
- LPCSTR pszProvName,
- DWORD dwProvType
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptSetProviderW(
- LPCWSTR pszProvName,
- DWORD dwProvType
- );
- #ifdef UNICODE
- #define CryptSetProvider CryptSetProviderW
- #else
- #define CryptSetProvider CryptSetProviderA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptSetProviderExA(
- LPCSTR pszProvName,
- DWORD dwProvType,
- DWORD *pdwReserved,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptSetProviderExW(
- LPCWSTR pszProvName,
- DWORD dwProvType,
- DWORD *pdwReserved,
- DWORD dwFlags
- );
- #ifdef UNICODE
- #define CryptSetProviderEx CryptSetProviderExW
- #else
- #define CryptSetProviderEx CryptSetProviderExA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptGetDefaultProviderA(
- DWORD dwProvType,
- DWORD *pdwReserved,
- DWORD dwFlags,
- LPSTR pszProvName,
- DWORD *pcbProvName
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptGetDefaultProviderW(
- DWORD dwProvType,
- DWORD *pdwReserved,
- DWORD dwFlags,
- LPWSTR pszProvName,
- DWORD *pcbProvName
- );
- #ifdef UNICODE
- #define CryptGetDefaultProvider CryptGetDefaultProviderW
- #else
- #define CryptGetDefaultProvider CryptGetDefaultProviderA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptEnumProviderTypesA(
- DWORD dwIndex,
- DWORD *pdwReserved,
- DWORD dwFlags,
- DWORD *pdwProvType,
- LPSTR szTypeName,
- DWORD *pcbTypeName
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptEnumProviderTypesW(
- DWORD dwIndex,
- DWORD *pdwReserved,
- DWORD dwFlags,
- DWORD *pdwProvType,
- LPWSTR szTypeName,
- DWORD *pcbTypeName
- );
- #ifdef UNICODE
- #define CryptEnumProviderTypes CryptEnumProviderTypesW
- #else
- #define CryptEnumProviderTypes CryptEnumProviderTypesA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptEnumProvidersA(
- DWORD dwIndex,
- DWORD *pdwReserved,
- DWORD dwFlags,
- DWORD *pdwProvType,
- LPSTR szProvName,
- DWORD *pcbProvName
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptEnumProvidersW(
- DWORD dwIndex,
- DWORD *pdwReserved,
- DWORD dwFlags,
- DWORD *pdwProvType,
- LPWSTR szProvName,
- DWORD *pcbProvName
- );
- #ifdef UNICODE
- #define CryptEnumProviders CryptEnumProvidersW
- #else
- #define CryptEnumProviders CryptEnumProvidersA
- #endif // !UNICODE
- WINADVAPI
- BOOL
- WINAPI
- CryptContextAddRef(
- HCRYPTPROV hProv,
- DWORD *pdwReserved,
- DWORD dwFlags
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptDuplicateKey(
- HCRYPTKEY hKey,
- DWORD *pdwReserved,
- DWORD dwFlags,
- HCRYPTKEY *phKey
- );
- WINADVAPI
- BOOL
- WINAPI
- CryptDuplicateHash(
- HCRYPTHASH hHash,
- DWORD *pdwReserved,
- DWORD dwFlags,
- HCRYPTHASH *phHash
- );
- typedef struct {
- DWORD dwVersion;
- ALG_ID algId;
- DWORD dwMinKeyLength;
- DWORD dwMaxKeyLength;
- DWORD dwRequiredFlags;
- DWORD dwDisallowedFlags;
- } _CRYPT_KEY_LIMITS_V01;
- typedef _CRYPT_KEY_LIMITS_V01 CRYPT_KEY_LIMITS, *PCRYPT_KEY_LIMITS;
- // Request Flag definitions
- #define CRYPTLIMIT_USING_PCT 0x0001
- #define CRYPTLIMIT_USING_SGC 0x0002
- WINADVAPI
- BOOL
- WINAPI
- CryptGetLocalKeyLimits(
- IN ALG_ID algId,
- IN DWORD dwFlags,
- OUT PCRYPT_KEY_LIMITS pLimits,
- IN OUT LPDWORD cbLimitLength);
- //+-------------------------------------------------------------------------
- // In a CRYPT_BIT_BLOB the last byte may contain 0-7 unused bits. Therefore, the
- // overall bit length is cbData * 8 - cUnusedBits.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_BIT_BLOB {
- DWORD cbData;
- BYTE *pbData;
- DWORD cUnusedBits;
- } CRYPT_BIT_BLOB, *PCRYPT_BIT_BLOB;
- //+-------------------------------------------------------------------------
- // Type used for any algorithm
- //
- // Where the Parameters CRYPT_OBJID_BLOB is in its encoded representation. For most
- // algorithm types, the Parameters CRYPT_OBJID_BLOB is NULL (Parameters.cbData = 0).
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_ALGORITHM_IDENTIFIER {
- LPSTR pszObjId;
- CRYPT_OBJID_BLOB Parameters;
- } CRYPT_ALGORITHM_IDENTIFIER, *PCRYPT_ALGORITHM_IDENTIFIER;
- // Following are the definitions of various algorithm object identifiers
- // RSA
- #define szOID_RSA "1.2.840.113549"
- #define szOID_PKCS "1.2.840.113549.1"
- #define szOID_RSA_HASH "1.2.840.113549.2"
- #define szOID_RSA_ENCRYPT "1.2.840.113549.3"
- #define szOID_PKCS_1 "1.2.840.113549.1.1"
- #define szOID_PKCS_2 "1.2.840.113549.1.2"
- #define szOID_PKCS_3 "1.2.840.113549.1.3"
- #define szOID_PKCS_4 "1.2.840.113549.1.4"
- #define szOID_PKCS_5 "1.2.840.113549.1.5"
- #define szOID_PKCS_6 "1.2.840.113549.1.6"
- #define szOID_PKCS_7 "1.2.840.113549.1.7"
- #define szOID_PKCS_8 "1.2.840.113549.1.8"
- #define szOID_PKCS_9 "1.2.840.113549.1.9"
- #define szOID_PKCS_10 "1.2.840.113549.1.10"
- #define szOID_PKCS_12 "1.2.840.113549.1.12"
- #define szOID_RSA_RSA "1.2.840.113549.1.1.1"
- #define szOID_RSA_MD2RSA "1.2.840.113549.1.1.2"
- #define szOID_RSA_MD4RSA "1.2.840.113549.1.1.3"
- #define szOID_RSA_MD5RSA "1.2.840.113549.1.1.4"
- #define szOID_RSA_SHA1RSA "1.2.840.113549.1.1.5"
- #define szOID_RSA_SETOAEP_RSA "1.2.840.113549.1.1.6"
- #define szOID_RSA_DH "1.2.840.113549.1.3.1"
- #define szOID_RSA_data "1.2.840.113549.1.7.1"
- #define szOID_RSA_signedData "1.2.840.113549.1.7.2"
- #define szOID_RSA_envelopedData "1.2.840.113549.1.7.3"
- #define szOID_RSA_signEnvData "1.2.840.113549.1.7.4"
- #define szOID_RSA_digestedData "1.2.840.113549.1.7.5"
- #define szOID_RSA_hashedData "1.2.840.113549.1.7.5"
- #define szOID_RSA_encryptedData "1.2.840.113549.1.7.6"
- #define szOID_RSA_emailAddr "1.2.840.113549.1.9.1"
- #define szOID_RSA_unstructName "1.2.840.113549.1.9.2"
- #define szOID_RSA_contentType "1.2.840.113549.1.9.3"
- #define szOID_RSA_messageDigest "1.2.840.113549.1.9.4"
- #define szOID_RSA_signingTime "1.2.840.113549.1.9.5"
- #define szOID_RSA_counterSign "1.2.840.113549.1.9.6"
- #define szOID_RSA_challengePwd "1.2.840.113549.1.9.7"
- #define szOID_RSA_unstructAddr "1.2.840.113549.1.9.8"
- #define szOID_RSA_extCertAttrs "1.2.840.113549.1.9.9"
- #define szOID_RSA_certExtensions "1.2.840.113549.1.9.14"
- #define szOID_RSA_SMIMECapabilities "1.2.840.113549.1.9.15"
- #define szOID_RSA_preferSignedData "1.2.840.113549.1.9.15.1"
- #define szOID_RSA_SMIMEalg "1.2.840.113549.1.9.16.3"
- #define szOID_RSA_SMIMEalgESDH "1.2.840.113549.1.9.16.3.5"
- #define szOID_RSA_SMIMEalgCMS3DESwrap "1.2.840.113549.1.9.16.3.6"
- #define szOID_RSA_SMIMEalgCMSRC2wrap "1.2.840.113549.1.9.16.3.7"
- #define szOID_RSA_MD2 "1.2.840.113549.2.2"
- #define szOID_RSA_MD4 "1.2.840.113549.2.4"
- #define szOID_RSA_MD5 "1.2.840.113549.2.5"
- #define szOID_RSA_RC2CBC "1.2.840.113549.3.2"
- #define szOID_RSA_RC4 "1.2.840.113549.3.4"
- #define szOID_RSA_DES_EDE3_CBC "1.2.840.113549.3.7"
- #define szOID_RSA_RC5_CBCPad "1.2.840.113549.3.9"
- #define szOID_ANSI_X942 "1.2.840.10046"
- #define szOID_ANSI_X942_DH "1.2.840.10046.2.1"
- #define szOID_X957 "1.2.840.10040"
- #define szOID_X957_DSA "1.2.840.10040.4.1"
- #define szOID_X957_SHA1DSA "1.2.840.10040.4.3"
- // ITU-T UsefulDefinitions
- #define szOID_DS "2.5"
- #define szOID_DSALG "2.5.8"
- #define szOID_DSALG_CRPT "2.5.8.1"
- #define szOID_DSALG_HASH "2.5.8.2"
- #define szOID_DSALG_SIGN "2.5.8.3"
- #define szOID_DSALG_RSA "2.5.8.1.1"
- // NIST OSE Implementors' Workshop (OIW)
- // http://nemo.ncsl.nist.gov/oiw/agreements/stable/OSI/12s_9506.w51
- // http://nemo.ncsl.nist.gov/oiw/agreements/working/OSI/12w_9503.w51
- #define szOID_OIW "1.3.14"
- // NIST OSE Implementors' Workshop (OIW) Security SIG algorithm identifiers
- #define szOID_OIWSEC "1.3.14.3.2"
- #define szOID_OIWSEC_md4RSA "1.3.14.3.2.2"
- #define szOID_OIWSEC_md5RSA "1.3.14.3.2.3"
- #define szOID_OIWSEC_md4RSA2 "1.3.14.3.2.4"
- #define szOID_OIWSEC_desECB "1.3.14.3.2.6"
- #define szOID_OIWSEC_desCBC "1.3.14.3.2.7"
- #define szOID_OIWSEC_desOFB "1.3.14.3.2.8"
- #define szOID_OIWSEC_desCFB "1.3.14.3.2.9"
- #define szOID_OIWSEC_desMAC "1.3.14.3.2.10"
- #define szOID_OIWSEC_rsaSign "1.3.14.3.2.11"
- #define szOID_OIWSEC_dsa "1.3.14.3.2.12"
- #define szOID_OIWSEC_shaDSA "1.3.14.3.2.13"
- #define szOID_OIWSEC_mdc2RSA "1.3.14.3.2.14"
- #define szOID_OIWSEC_shaRSA "1.3.14.3.2.15"
- #define szOID_OIWSEC_dhCommMod "1.3.14.3.2.16"
- #define szOID_OIWSEC_desEDE "1.3.14.3.2.17"
- #define szOID_OIWSEC_sha "1.3.14.3.2.18"
- #define szOID_OIWSEC_mdc2 "1.3.14.3.2.19"
- #define szOID_OIWSEC_dsaComm "1.3.14.3.2.20"
- #define szOID_OIWSEC_dsaCommSHA "1.3.14.3.2.21"
- #define szOID_OIWSEC_rsaXchg "1.3.14.3.2.22"
- #define szOID_OIWSEC_keyHashSeal "1.3.14.3.2.23"
- #define szOID_OIWSEC_md2RSASign "1.3.14.3.2.24"
- #define szOID_OIWSEC_md5RSASign "1.3.14.3.2.25"
- #define szOID_OIWSEC_sha1 "1.3.14.3.2.26"
- #define szOID_OIWSEC_dsaSHA1 "1.3.14.3.2.27"
- #define szOID_OIWSEC_dsaCommSHA1 "1.3.14.3.2.28"
- #define szOID_OIWSEC_sha1RSASign "1.3.14.3.2.29"
- // NIST OSE Implementors' Workshop (OIW) Directory SIG algorithm identifiers
- #define szOID_OIWDIR "1.3.14.7.2"
- #define szOID_OIWDIR_CRPT "1.3.14.7.2.1"
- #define szOID_OIWDIR_HASH "1.3.14.7.2.2"
- #define szOID_OIWDIR_SIGN "1.3.14.7.2.3"
- #define szOID_OIWDIR_md2 "1.3.14.7.2.2.1"
- #define szOID_OIWDIR_md2RSA "1.3.14.7.2.3.1"
- // INFOSEC Algorithms
- // joint-iso-ccitt(2) country(16) us(840) organization(1) us-government(101) dod(2) id-infosec(1)
- #define szOID_INFOSEC "2.16.840.1.101.2.1"
- #define szOID_INFOSEC_sdnsSignature "2.16.840.1.101.2.1.1.1"
- #define szOID_INFOSEC_mosaicSignature "2.16.840.1.101.2.1.1.2"
- #define szOID_INFOSEC_sdnsConfidentiality "2.16.840.1.101.2.1.1.3"
- #define szOID_INFOSEC_mosaicConfidentiality "2.16.840.1.101.2.1.1.4"
- #define szOID_INFOSEC_sdnsIntegrity "2.16.840.1.101.2.1.1.5"
- #define szOID_INFOSEC_mosaicIntegrity "2.16.840.1.101.2.1.1.6"
- #define szOID_INFOSEC_sdnsTokenProtection "2.16.840.1.101.2.1.1.7"
- #define szOID_INFOSEC_mosaicTokenProtection "2.16.840.1.101.2.1.1.8"
- #define szOID_INFOSEC_sdnsKeyManagement "2.16.840.1.101.2.1.1.9"
- #define szOID_INFOSEC_mosaicKeyManagement "2.16.840.1.101.2.1.1.10"
- #define szOID_INFOSEC_sdnsKMandSig "2.16.840.1.101.2.1.1.11"
- #define szOID_INFOSEC_mosaicKMandSig "2.16.840.1.101.2.1.1.12"
- #define szOID_INFOSEC_SuiteASignature "2.16.840.1.101.2.1.1.13"
- #define szOID_INFOSEC_SuiteAConfidentiality "2.16.840.1.101.2.1.1.14"
- #define szOID_INFOSEC_SuiteAIntegrity "2.16.840.1.101.2.1.1.15"
- #define szOID_INFOSEC_SuiteATokenProtection "2.16.840.1.101.2.1.1.16"
- #define szOID_INFOSEC_SuiteAKeyManagement "2.16.840.1.101.2.1.1.17"
- #define szOID_INFOSEC_SuiteAKMandSig "2.16.840.1.101.2.1.1.18"
- #define szOID_INFOSEC_mosaicUpdatedSig "2.16.840.1.101.2.1.1.19"
- #define szOID_INFOSEC_mosaicKMandUpdSig "2.16.840.1.101.2.1.1.20"
- #define szOID_INFOSEC_mosaicUpdatedInteg "2.16.840.1.101.2.1.1.21"
- typedef struct _CRYPT_OBJID_TABLE {
- DWORD dwAlgId;
- LPCSTR pszObjId;
- } CRYPT_OBJID_TABLE, *PCRYPT_OBJID_TABLE;
- //+-------------------------------------------------------------------------
- // PKCS #1 HashInfo (DigestInfo)
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_HASH_INFO {
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- CRYPT_HASH_BLOB Hash;
- } CRYPT_HASH_INFO, *PCRYPT_HASH_INFO;
- //+-------------------------------------------------------------------------
- // Type used for an extension to an encoded content
- //
- // Where the Value's CRYPT_OBJID_BLOB is in its encoded representation.
- //--------------------------------------------------------------------------
- typedef struct _CERT_EXTENSION {
- LPSTR pszObjId;
- BOOL fCritical;
- CRYPT_OBJID_BLOB Value;
- } CERT_EXTENSION, *PCERT_EXTENSION;
- //+-------------------------------------------------------------------------
- // AttributeTypeValue
- //
- // Where the Value's CRYPT_OBJID_BLOB is in its encoded representation.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_ATTRIBUTE_TYPE_VALUE {
- LPSTR pszObjId;
- CRYPT_OBJID_BLOB Value;
- } CRYPT_ATTRIBUTE_TYPE_VALUE, *PCRYPT_ATTRIBUTE_TYPE_VALUE;
- //+-------------------------------------------------------------------------
- // Attributes
- //
- // Where the Value's PATTR_BLOBs are in their encoded representation.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_ATTRIBUTE {
- LPSTR pszObjId;
- DWORD cValue;
- PCRYPT_ATTR_BLOB rgValue;
- } CRYPT_ATTRIBUTE, *PCRYPT_ATTRIBUTE;
- typedef struct _CRYPT_ATTRIBUTES {
- IN DWORD cAttr;
- IN PCRYPT_ATTRIBUTE rgAttr;
- } CRYPT_ATTRIBUTES, *PCRYPT_ATTRIBUTES;
- //+-------------------------------------------------------------------------
- // Attributes making up a Relative Distinguished Name (CERT_RDN)
- //
- // The interpretation of the Value depends on the dwValueType.
- // See below for a list of the types.
- //--------------------------------------------------------------------------
- typedef struct _CERT_RDN_ATTR {
- LPSTR pszObjId;
- DWORD dwValueType;
- CERT_RDN_VALUE_BLOB Value;
- } CERT_RDN_ATTR, *PCERT_RDN_ATTR;
- //+-------------------------------------------------------------------------
- // CERT_RDN attribute Object Identifiers
- //--------------------------------------------------------------------------
- // Labeling attribute types:
- #define szOID_COMMON_NAME "2.5.4.3" // case-ignore string
- #define szOID_SUR_NAME "2.5.4.4" // case-ignore string
- #define szOID_DEVICE_SERIAL_NUMBER "2.5.4.5" // printable string
- // Geographic attribute types:
- #define szOID_COUNTRY_NAME "2.5.4.6" // printable 2char string
- #define szOID_LOCALITY_NAME "2.5.4.7" // case-ignore string
- #define szOID_STATE_OR_PROVINCE_NAME "2.5.4.8" // case-ignore string
- #define szOID_STREET_ADDRESS "2.5.4.9" // case-ignore string
- // Organizational attribute types:
- #define szOID_ORGANIZATION_NAME "2.5.4.10" // case-ignore string
- #define szOID_ORGANIZATIONAL_UNIT_NAME "2.5.4.11" // case-ignore string
- #define szOID_TITLE "2.5.4.12" // case-ignore string
- // Explanatory attribute types:
- #define szOID_DESCRIPTION "2.5.4.13" // case-ignore string
- #define szOID_SEARCH_GUIDE "2.5.4.14"
- #define szOID_BUSINESS_CATEGORY "2.5.4.15" // case-ignore string
- // Postal addressing attribute types:
- #define szOID_POSTAL_ADDRESS "2.5.4.16"
- #define szOID_POSTAL_CODE "2.5.4.17" // case-ignore string
- #define szOID_POST_OFFICE_BOX "2.5.4.18" // case-ignore string
- #define szOID_PHYSICAL_DELIVERY_OFFICE_NAME "2.5.4.19" // case-ignore string
- // Telecommunications addressing attribute types:
- #define szOID_TELEPHONE_NUMBER "2.5.4.20" // telephone number
- #define szOID_TELEX_NUMBER "2.5.4.21"
- #define szOID_TELETEXT_TERMINAL_IDENTIFIER "2.5.4.22"
- #define szOID_FACSIMILE_TELEPHONE_NUMBER "2.5.4.23"
- #define szOID_X21_ADDRESS "2.5.4.24" // numeric string
- #define szOID_INTERNATIONAL_ISDN_NUMBER "2.5.4.25" // numeric string
- #define szOID_REGISTERED_ADDRESS "2.5.4.26"
- #define szOID_DESTINATION_INDICATOR "2.5.4.27" // printable string
- // Preference attribute types:
- #define szOID_PREFERRED_DELIVERY_METHOD "2.5.4.28"
- // OSI application attribute types:
- #define szOID_PRESENTATION_ADDRESS "2.5.4.29"
- #define szOID_SUPPORTED_APPLICATION_CONTEXT "2.5.4.30"
- // Relational application attribute types:
- #define szOID_MEMBER "2.5.4.31"
- #define szOID_OWNER "2.5.4.32"
- #define szOID_ROLE_OCCUPANT "2.5.4.33"
- #define szOID_SEE_ALSO "2.5.4.34"
- // Security attribute types:
- #define szOID_USER_PASSWORD "2.5.4.35"
- #define szOID_USER_CERTIFICATE "2.5.4.36"
- #define szOID_CA_CERTIFICATE "2.5.4.37"
- #define szOID_AUTHORITY_REVOCATION_LIST "2.5.4.38"
- #define szOID_CERTIFICATE_REVOCATION_LIST "2.5.4.39"
- #define szOID_CROSS_CERTIFICATE_PAIR "2.5.4.40"
- // Undocumented attribute types???
- //#define szOID_??? "2.5.4.41"
- #define szOID_GIVEN_NAME "2.5.4.42" // case-ignore string
- #define szOID_INITIALS "2.5.4.43" // case-ignore string
- // The DN Qualifier attribute type specifies disambiguating information to add
- // to the relative distinguished name of an entry. It is intended to be used
- // for entries held in multiple DSAs which would otherwise have the same name,
- // and that its value be the same in a given DSA for all entries to which
- // the information has been added.
- #define szOID_DN_QUALIFIER "2.5.4.46"
- // Pilot user attribute types:
- #define szOID_DOMAIN_COMPONENT "0.9.2342.19200300.100.1.25" // IA5, UTF8 string
- // used for PKCS 12 attributes
- #define szOID_PKCS_12_FRIENDLY_NAME_ATTR "1.2.840.113549.1.9.20"
- #define szOID_PKCS_12_LOCAL_KEY_ID "1.2.840.113549.1.9.21"
- #define szOID_PKCS_12_KEY_PROVIDER_NAME_ATTR "1.3.6.1.4.1.311.17.1"
- #define szOID_LOCAL_MACHINE_KEYSET "1.3.6.1.4.1.311.17.2"
- //+-------------------------------------------------------------------------
- // Microsoft CERT_RDN attribute Object Identifiers
- //--------------------------------------------------------------------------
- // Special RDN containing the KEY_ID. Its value type is CERT_RDN_OCTET_STRING.
- #define szOID_KEYID_RDN "1.3.6.1.4.1.311.10.7.1"
- //+-------------------------------------------------------------------------
- // CERT_RDN Attribute Value Types
- //
- // For RDN_ENCODED_BLOB, the Value's CERT_RDN_VALUE_BLOB is in its encoded
- // representation. Otherwise, its an array of bytes.
- //
- // For all CERT_RDN types, Value.cbData is always the number of bytes, not
- // necessarily the number of elements in the string. For instance,
- // RDN_UNIVERSAL_STRING is an array of ints (cbData == intCnt * 4) and
- // RDN_BMP_STRING is an array of unsigned shorts (cbData == ushortCnt * 2).
- //
- // A RDN_UTF8_STRING is an array of UNICODE characters (cbData == charCnt *2).
- // These UNICODE characters are encoded as UTF8 8 bit characters.
- //
- // For CertDecodeName, two 0 bytes are always appended to the end of the
- // string (ensures a CHAR or WCHAR string is null terminated).
- // These added 0 bytes are't included in the BLOB.cbData.
- //--------------------------------------------------------------------------
- #define CERT_RDN_ANY_TYPE 0
- #define CERT_RDN_ENCODED_BLOB 1
- #define CERT_RDN_OCTET_STRING 2
- #define CERT_RDN_NUMERIC_STRING 3
- #define CERT_RDN_PRINTABLE_STRING 4
- #define CERT_RDN_TELETEX_STRING 5
- #define CERT_RDN_T61_STRING 5
- #define CERT_RDN_VIDEOTEX_STRING 6
- #define CERT_RDN_IA5_STRING 7
- #define CERT_RDN_GRAPHIC_STRING 8
- #define CERT_RDN_VISIBLE_STRING 9
- #define CERT_RDN_ISO646_STRING 9
- #define CERT_RDN_GENERAL_STRING 10
- #define CERT_RDN_UNIVERSAL_STRING 11
- #define CERT_RDN_INT4_STRING 11
- #define CERT_RDN_BMP_STRING 12
- #define CERT_RDN_UNICODE_STRING 12
- #define CERT_RDN_UTF8_STRING 13
- #define CERT_RDN_TYPE_MASK 0x000000FF
- #define CERT_RDN_FLAGS_MASK 0xFF000000
- //+-------------------------------------------------------------------------
- // Flags that can be or'ed with the above Value Type when encoding/decoding
- //--------------------------------------------------------------------------
- // For encoding: when set, CERT_RDN_T61_STRING is selected instead of
- // CERT_RDN_UNICODE_STRING if all the unicode characters are <= 0xFF
- #define CERT_RDN_ENABLE_T61_UNICODE_FLAG 0x80000000
- // For encoding: when set, CERT_RDN_UTF8_STRING is selected instead of
- // CERT_RDN_UNICODE_STRING.
- #define CERT_RDN_ENABLE_UTF8_UNICODE_FLAG 0x20000000
- // For encoding: when set, the characters aren't checked to see if they
- // are valid for the Value Type.
- #define CERT_RDN_DISABLE_CHECK_TYPE_FLAG 0x40000000
- // For decoding: by default, CERT_RDN_T61_STRING values are initially decoded
- // as UTF8. If the UTF8 decoding fails, then, decoded as 8 bit characters.
- // Setting this flag skips the initial attempt to decode as UTF8.
- #define CERT_RDN_DISABLE_IE4_UTF8_FLAG 0x01000000
- // Macro to check that the dwValueType is a character string and not an
- // encoded blob or octet string
- #define IS_CERT_RDN_CHAR_STRING(X) \
- (((X) & CERT_RDN_TYPE_MASK) >= CERT_RDN_NUMERIC_STRING)
- //+-------------------------------------------------------------------------
- // A CERT_RDN consists of an array of the above attributes
- //--------------------------------------------------------------------------
- typedef struct _CERT_RDN {
- DWORD cRDNAttr;
- PCERT_RDN_ATTR rgRDNAttr;
- } CERT_RDN, *PCERT_RDN;
- //+-------------------------------------------------------------------------
- // Information stored in a subject's or issuer's name. The information
- // is represented as an array of the above RDNs.
- //--------------------------------------------------------------------------
- typedef struct _CERT_NAME_INFO {
- DWORD cRDN;
- PCERT_RDN rgRDN;
- } CERT_NAME_INFO, *PCERT_NAME_INFO;
- //+-------------------------------------------------------------------------
- // Name attribute value without the Object Identifier
- //
- // The interpretation of the Value depends on the dwValueType.
- // See above for a list of the types.
- //--------------------------------------------------------------------------
- typedef struct _CERT_NAME_VALUE {
- DWORD dwValueType;
- CERT_RDN_VALUE_BLOB Value;
- } CERT_NAME_VALUE, *PCERT_NAME_VALUE;
- //+-------------------------------------------------------------------------
- // Public Key Info
- //
- // The PublicKey is the encoded representation of the information as it is
- // stored in the bit string
- //--------------------------------------------------------------------------
- typedef struct _CERT_PUBLIC_KEY_INFO {
- CRYPT_ALGORITHM_IDENTIFIER Algorithm;
- CRYPT_BIT_BLOB PublicKey;
- } CERT_PUBLIC_KEY_INFO, *PCERT_PUBLIC_KEY_INFO;
- #define CERT_RSA_PUBLIC_KEY_OBJID szOID_RSA_RSA
- #define CERT_DEFAULT_OID_PUBLIC_KEY_SIGN szOID_RSA_RSA
- #define CERT_DEFAULT_OID_PUBLIC_KEY_XCHG szOID_RSA_RSA
- //+-------------------------------------------------------------------------
- // structure that contains all the information in a PKCS#8 PrivateKeyInfo
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_PRIVATE_KEY_INFO{
- DWORD Version;
- CRYPT_ALGORITHM_IDENTIFIER Algorithm;
- CRYPT_DER_BLOB PrivateKey;
- PCRYPT_ATTRIBUTES pAttributes;
- } CRYPT_PRIVATE_KEY_INFO, *PCRYPT_PRIVATE_KEY_INFO;
- //+-------------------------------------------------------------------------
- // structure that contains all the information in a PKCS#8
- // EncryptedPrivateKeyInfo
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_ENCRYPTED_PRIVATE_KEY_INFO{
- CRYPT_ALGORITHM_IDENTIFIER EncryptionAlgorithm;
- CRYPT_DATA_BLOB EncryptedPrivateKey;
- } CRYPT_ENCRYPTED_PRIVATE_KEY_INFO, *PCRYPT_ENCRYPTED_PRIVATE_KEY_INFO;
- //+-------------------------------------------------------------------------
- // this callback is given when an EncryptedProvateKeyInfo structure is
- // encountered during ImportPKCS8. the caller is then expected to decrypt
- // the private key and hand back the decrypted contents.
- //
- // the parameters are:
- // Algorithm - the algorithm used to encrypt the PrivateKeyInfo
- // EncryptedPrivateKey - the encrypted private key blob
- // pClearTextKey - a buffer to receive the clear text
- // cbClearTextKey - the number of bytes of the pClearTextKey buffer
- // note the if this is zero then this should be
- // filled in with the size required to decrypt the
- // key into, and pClearTextKey should be ignored
- // pVoidDecryptFunc - this is the pVoid that was passed into the call
- // and is preserved and passed back as context
- //+-------------------------------------------------------------------------
- typedef BOOL (CALLBACK *PCRYPT_DECRYPT_PRIVATE_KEY_FUNC)(
- CRYPT_ALGORITHM_IDENTIFIER Algorithm,
- CRYPT_DATA_BLOB EncryptedPrivateKey,
- BYTE *pbClearTextKey,
- DWORD *pcbClearTextKey,
- LPVOID pVoidDecryptFunc);
- //+-------------------------------------------------------------------------
- // this callback is given when creating a PKCS8 EncryptedPrivateKeyInfo.
- // The caller is then expected to encrypt the private key and hand back
- // the encrypted contents.
- //
- // the parameters are:
- // Algorithm - the algorithm used to encrypt the PrivateKeyInfo
- // pClearTextPrivateKey - the cleartext private key to be encrypted
- // pbEncryptedKey - the output encrypted private key blob
- // cbEncryptedKey - the number of bytes of the pbEncryptedKey buffer
- // note the if this is zero then this should be
- // filled in with the size required to encrypt the
- // key into, and pbEncryptedKey should be ignored
- // pVoidEncryptFunc - this is the pVoid that was passed into the call
- // and is preserved and passed back as context
- //+-------------------------------------------------------------------------
- typedef BOOL (CALLBACK *PCRYPT_ENCRYPT_PRIVATE_KEY_FUNC)(
- CRYPT_ALGORITHM_IDENTIFIER* pAlgorithm,
- CRYPT_DATA_BLOB* pClearTextPrivateKey,
- BYTE *pbEncryptedKey,
- DWORD *pcbEncryptedKey,
- LPVOID pVoidEncryptFunc);
- //+-------------------------------------------------------------------------
- // this callback is given from the context of a ImportPKCS8 calls. the caller
- // is then expected to hand back an HCRYPTPROV to receive the key being imported
- //
- // the parameters are:
- // pPrivateKeyInfo - pointer to a CRYPT_PRIVATE_KEY_INFO structure which
- // describes the key being imported
- // EncryptedPrivateKey - the encrypted private key blob
- // phCryptProv - a pointer to a HCRRYPTPROV to be filled in
- // pVoidResolveFunc - this is the pVoidResolveFunc passed in by the caller in the
- // CRYPT_PRIVATE_KEY_BLOB_AND_PARAMS struct
- //+-------------------------------------------------------------------------
- typedef BOOL (CALLBACK *PCRYPT_RESOLVE_HCRYPTPROV_FUNC)(
- CRYPT_PRIVATE_KEY_INFO *pPrivateKeyInfo,
- HCRYPTPROV *phCryptProv,
- LPVOID pVoidResolveFunc);
- //+-------------------------------------------------------------------------
- // this struct contains a PKCS8 private key and two pointers to callback
- // functions, with a corresponding pVoids. the first callback is used to give
- // the caller the opportunity to specify where the key is imported to. the callback
- // passes the caller the algoroithm OID and key size to use in making the decision.
- // the other callback is used to decrypt the private key if the PKCS8 contains an
- // EncryptedPrivateKeyInfo. both pVoids are preserved and passed back to the caller
- // in the respective callback
- //+-------------------------------------------------------------------------
- typedef struct _CRYPT_PKCS8_IMPORT_PARAMS{
- CRYPT_DIGEST_BLOB PrivateKey; // PKCS8 blob
- PCRYPT_RESOLVE_HCRYPTPROV_FUNC pResolvehCryptProvFunc; // optional
- LPVOID pVoidResolveFunc; // optional
- PCRYPT_DECRYPT_PRIVATE_KEY_FUNC pDecryptPrivateKeyFunc;
- LPVOID pVoidDecryptFunc;
- } CRYPT_PKCS8_IMPORT_PARAMS, *PCRYPT_PKCS8_IMPORT_PARAMS, CRYPT_PRIVATE_KEY_BLOB_AND_PARAMS, *PCRYPT_PRIVATE_KEY_BLOB_AND_PARAMS;
- //+-------------------------------------------------------------------------
- // this struct contains information identifying a private key and a pointer
- // to a callback function, with a corresponding pVoid. The callback is used
- // to encrypt the private key. If the pEncryptPrivateKeyFunc is NULL, the
- // key will not be encrypted and an EncryptedPrivateKeyInfo will not be generated.
- // The pVoid is preserved and passed back to the caller in the respective callback
- //+-------------------------------------------------------------------------
- typedef struct _CRYPT_PKCS8_EXPORT_PARAMS{
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- LPSTR pszPrivateKeyObjId;
- PCRYPT_ENCRYPT_PRIVATE_KEY_FUNC pEncryptPrivateKeyFunc;
- LPVOID pVoidEncryptFunc;
- } CRYPT_PKCS8_EXPORT_PARAMS, *PCRYPT_PKCS8_EXPORT_PARAMS;
- //+-------------------------------------------------------------------------
- // Information stored in a certificate
- //
- // The Issuer, Subject, Algorithm, PublicKey and Extension BLOBs are the
- // encoded representation of the information.
- //--------------------------------------------------------------------------
- typedef struct _CERT_INFO {
- DWORD dwVersion;
- CRYPT_INTEGER_BLOB SerialNumber;
- CRYPT_ALGORITHM_IDENTIFIER SignatureAlgorithm;
- CERT_NAME_BLOB Issuer;
- FILETIME NotBefore;
- FILETIME NotAfter;
- CERT_NAME_BLOB Subject;
- CERT_PUBLIC_KEY_INFO SubjectPublicKeyInfo;
- CRYPT_BIT_BLOB IssuerUniqueId;
- CRYPT_BIT_BLOB SubjectUniqueId;
- DWORD cExtension;
- PCERT_EXTENSION rgExtension;
- } CERT_INFO, *PCERT_INFO;
- //+-------------------------------------------------------------------------
- // Certificate versions
- //--------------------------------------------------------------------------
- #define CERT_V1 0
- #define CERT_V2 1
- #define CERT_V3 2
- //+-------------------------------------------------------------------------
- // Certificate Information Flags
- //--------------------------------------------------------------------------
- #define CERT_INFO_VERSION_FLAG 1
- #define CERT_INFO_SERIAL_NUMBER_FLAG 2
- #define CERT_INFO_SIGNATURE_ALGORITHM_FLAG 3
- #define CERT_INFO_ISSUER_FLAG 4
- #define CERT_INFO_NOT_BEFORE_FLAG 5
- #define CERT_INFO_NOT_AFTER_FLAG 6
- #define CERT_INFO_SUBJECT_FLAG 7
- #define CERT_INFO_SUBJECT_PUBLIC_KEY_INFO_FLAG 8
- #define CERT_INFO_ISSUER_UNIQUE_ID_FLAG 9
- #define CERT_INFO_SUBJECT_UNIQUE_ID_FLAG 10
- #define CERT_INFO_EXTENSION_FLAG 11
- //+-------------------------------------------------------------------------
- // An entry in a CRL
- //
- // The Extension BLOBs are the encoded representation of the information.
- //--------------------------------------------------------------------------
- typedef struct _CRL_ENTRY {
- CRYPT_INTEGER_BLOB SerialNumber;
- FILETIME RevocationDate;
- DWORD cExtension;
- PCERT_EXTENSION rgExtension;
- } CRL_ENTRY, *PCRL_ENTRY;
- //+-------------------------------------------------------------------------
- // Information stored in a CRL
- //
- // The Issuer, Algorithm and Extension BLOBs are the encoded
- // representation of the information.
- //--------------------------------------------------------------------------
- typedef struct _CRL_INFO {
- DWORD dwVersion;
- CRYPT_ALGORITHM_IDENTIFIER SignatureAlgorithm;
- CERT_NAME_BLOB Issuer;
- FILETIME ThisUpdate;
- FILETIME NextUpdate;
- DWORD cCRLEntry;
- PCRL_ENTRY rgCRLEntry;
- DWORD cExtension;
- PCERT_EXTENSION rgExtension;
- } CRL_INFO, *PCRL_INFO;
- //+-------------------------------------------------------------------------
- // CRL versions
- //--------------------------------------------------------------------------
- #define CRL_V1 0
- #define CRL_V2 1
- //+-------------------------------------------------------------------------
- // Information stored in a certificate request
- //
- // The Subject, Algorithm, PublicKey and Attribute BLOBs are the encoded
- // representation of the information.
- //--------------------------------------------------------------------------
- typedef struct _CERT_REQUEST_INFO {
- DWORD dwVersion;
- CERT_NAME_BLOB Subject;
- CERT_PUBLIC_KEY_INFO SubjectPublicKeyInfo;
- DWORD cAttribute;
- PCRYPT_ATTRIBUTE rgAttribute;
- } CERT_REQUEST_INFO, *PCERT_REQUEST_INFO;
- //+-------------------------------------------------------------------------
- // Certificate Request versions
- //--------------------------------------------------------------------------
- #define CERT_REQUEST_V1 0
- //+-------------------------------------------------------------------------
- // Information stored in Netscape's Keygen request
- //--------------------------------------------------------------------------
- typedef struct _CERT_KEYGEN_REQUEST_INFO {
- DWORD dwVersion;
- CERT_PUBLIC_KEY_INFO SubjectPublicKeyInfo;
- LPWSTR pwszChallengeString; // encoded as IA5
- } CERT_KEYGEN_REQUEST_INFO, *PCERT_KEYGEN_REQUEST_INFO;
- #define CERT_KEYGEN_REQUEST_V1 0
- //+-------------------------------------------------------------------------
- // Certificate, CRL, Certificate Request or Keygen Request Signed Content
- //
- // The "to be signed" encoded content plus its signature. The ToBeSigned
- // is the encoded CERT_INFO, CRL_INFO, CERT_REQUEST_INFO or
- // CERT_KEYGEN_REQUEST_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_SIGNED_CONTENT_INFO {
- CRYPT_DER_BLOB ToBeSigned;
- CRYPT_ALGORITHM_IDENTIFIER SignatureAlgorithm;
- CRYPT_BIT_BLOB Signature;
- } CERT_SIGNED_CONTENT_INFO, *PCERT_SIGNED_CONTENT_INFO;
- //+-------------------------------------------------------------------------
- // Certificate Trust List (CTL)
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CTL Usage. Also used for EnhancedKeyUsage extension.
- //--------------------------------------------------------------------------
- typedef struct _CTL_USAGE {
- DWORD cUsageIdentifier;
- LPSTR *rgpszUsageIdentifier; // array of pszObjId
- } CTL_USAGE, *PCTL_USAGE,
- CERT_ENHKEY_USAGE, *PCERT_ENHKEY_USAGE;
- //+-------------------------------------------------------------------------
- // An entry in a CTL
- //--------------------------------------------------------------------------
- typedef struct _CTL_ENTRY {
- CRYPT_DATA_BLOB SubjectIdentifier; // For example, its hash
- DWORD cAttribute;
- PCRYPT_ATTRIBUTE rgAttribute; // OPTIONAL
- } CTL_ENTRY, *PCTL_ENTRY;
- //+-------------------------------------------------------------------------
- // Information stored in a CTL
- //--------------------------------------------------------------------------
- typedef struct _CTL_INFO {
- DWORD dwVersion;
- CTL_USAGE SubjectUsage;
- CRYPT_DATA_BLOB ListIdentifier; // OPTIONAL
- CRYPT_INTEGER_BLOB SequenceNumber; // OPTIONAL
- FILETIME ThisUpdate;
- FILETIME NextUpdate; // OPTIONAL
- CRYPT_ALGORITHM_IDENTIFIER SubjectAlgorithm;
- DWORD cCTLEntry;
- PCTL_ENTRY rgCTLEntry; // OPTIONAL
- DWORD cExtension;
- PCERT_EXTENSION rgExtension; // OPTIONAL
- } CTL_INFO, *PCTL_INFO;
- //+-------------------------------------------------------------------------
- // CTL versions
- //--------------------------------------------------------------------------
- #define CTL_V1 0
- //+-------------------------------------------------------------------------
- // TimeStamp Request
- //
- // The pszTimeStamp is the OID for the Time type requested
- // The pszContentType is the Content Type OID for the content, usually DATA
- // The Content is a un-decoded blob
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_TIME_STAMP_REQUEST_INFO {
- LPSTR pszTimeStampAlgorithm; // pszObjId
- LPSTR pszContentType; // pszObjId
- CRYPT_OBJID_BLOB Content;
- DWORD cAttribute;
- PCRYPT_ATTRIBUTE rgAttribute;
- } CRYPT_TIME_STAMP_REQUEST_INFO, *PCRYPT_TIME_STAMP_REQUEST_INFO;
- //+-------------------------------------------------------------------------
- // Name Value Attribute
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_ENROLLMENT_NAME_VALUE_PAIR {
- LPWSTR pwszName;
- LPWSTR pwszValue;
- } CRYPT_ENROLLMENT_NAME_VALUE_PAIR, * PCRYPT_ENROLLMENT_NAME_VALUE_PAIR;
- //+-------------------------------------------------------------------------
- // CSP Provider
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_CSP_PROVIDER {
- DWORD dwKeySpec;
- LPWSTR pwszProviderName;
- CRYPT_BIT_BLOB Signature;
- } CRYPT_CSP_PROVIDER, * PCRYPT_CSP_PROVIDER;
- //+-------------------------------------------------------------------------
- // Certificate and Message encoding types
- //
- // The encoding type is a DWORD containing both the certificate and message
- // encoding types. The certificate encoding type is stored in the LOWORD.
- // The message encoding type is stored in the HIWORD. Some functions or
- // structure fields require only one of the encoding types. The following
- // naming convention is used to indicate which encoding type(s) are
- // required:
- // dwEncodingType (both encoding types are required)
- // dwMsgAndCertEncodingType (both encoding types are required)
- // dwMsgEncodingType (only msg encoding type is required)
- // dwCertEncodingType (only cert encoding type is required)
- //
- // Its always acceptable to specify both.
- //--------------------------------------------------------------------------
- #define CERT_ENCODING_TYPE_MASK 0x0000FFFF
- #define CMSG_ENCODING_TYPE_MASK 0xFFFF0000
- #define GET_CERT_ENCODING_TYPE(X) (X & CERT_ENCODING_TYPE_MASK)
- #define GET_CMSG_ENCODING_TYPE(X) (X & CMSG_ENCODING_TYPE_MASK)
- #define CRYPT_ASN_ENCODING 0x00000001
- #define CRYPT_NDR_ENCODING 0x00000002
- #define X509_ASN_ENCODING 0x00000001
- #define X509_NDR_ENCODING 0x00000002
- #define PKCS_7_ASN_ENCODING 0x00010000
- #define PKCS_7_NDR_ENCODING 0x00020000
- //+-------------------------------------------------------------------------
- // format the specified data structure according to the certificate
- // encoding type.
- //
- // The default behavior of CryptFormatObject is to return single line
- // display of the encoded data, that is, each subfield will be concatenated with
- // a ", " on one line. If user prefers to display the data in multiple line,
- // set the flag CRYPT_FORMAT_STR_MULTI_LINE, that is, each subfield will be displayed
- // on a seperate line.
- //
- // If there is no formatting routine installed or registered
- // for the lpszStructType, the hex dump of the encoded BLOB will be returned.
- // User can set the flag CRYPT_FORMAT_STR_NO_HEX to disable the hex dump.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptFormatObject(
- IN DWORD dwCertEncodingType,
- IN DWORD dwFormatType,
- IN DWORD dwFormatStrType,
- IN void *pFormatStruct,
- IN LPCSTR lpszStructType,
- IN const BYTE *pbEncoded,
- IN DWORD cbEncoded,
- OUT void *pbFormat,
- IN OUT DWORD *pcbFormat
- );
- //-------------------------------------------------------------------------
- // constants for dwFormatStrType of function CryptFormatObject
- //-------------------------------------------------------------------------
- #define CRYPT_FORMAT_STR_MULTI_LINE 0x0001
- #define CRYPT_FORMAT_STR_NO_HEX 0x0010
- //-------------------------------------------------------------------------
- // constants for dwFormatType of function CryptFormatObject
- // when format X509_NAME or X509_UNICODE_NAME
- //-------------------------------------------------------------------------
- // Just get the simple string
- #define CRYPT_FORMAT_SIMPLE 0x0001
- //Put an attribute name infront of the attribute
- //such as "O=Microsoft,DN=xiaohs"
- #define CRYPT_FORMAT_X509 0x0002
- //Put an OID infront of the simple string, such as
- //"2.5.4.22=Microsoft,2.5.4.3=xiaohs"
- #define CRYPT_FORMAT_OID 0x0004
- //Put a ";" between each RDN. The default is ","
- #define CRYPT_FORMAT_RDN_SEMICOLON 0x0100
- //Put a "\n" between each RDN.
- #define CRYPT_FORMAT_RDN_CRLF 0x0200
- //Unquote the DN value, which is quoated by default va the following
- //rules: if the DN contains leading or trailing
- //white space or one of the following characters: ",", "+", "=",
- //""", "\n", "<", ">", "#" or ";". The quoting character is ".
- //If the DN Value contains a " it is double quoted ("").
- #define CRYPT_FORMAT_RDN_UNQUOTE 0x0400
- //reverse the order of the RDNs before converting to the string
- #define CRYPT_FORMAT_RDN_REVERSE 0x0800
- //-------------------------------------------------------------------------
- // contants dwFormatType of function CryptFormatObject when format a DN.:
- //
- // The following three values are defined in the section above:
- // CRYPT_FORMAT_SIMPLE: Just a simple string
- // such as "Microsoft+xiaohs+NT"
- // CRYPT_FORMAT_X509 Put an attribute name infront of the attribute
- // such as "O=Microsoft+xiaohs+NT"
- //
- // CRYPT_FORMAT_OID Put an OID infront of the simple string,
- // such as "2.5.4.22=Microsoft+xiaohs+NT"
- //
- // Additional values are defined as following:
- //----------------------------------------------------------------------------
- //Put a "," between each value. Default is "+"
- #define CRYPT_FORMAT_COMMA 0x1000
- //Put a ";" between each value
- #define CRYPT_FORMAT_SEMICOLON CRYPT_FORMAT_RDN_SEMICOLON
- //Put a "\n" between each value
- #define CRYPT_FORMAT_CRLF CRYPT_FORMAT_RDN_CRLF
- //+-------------------------------------------------------------------------
- // Encode / decode the specified data structure according to the certificate
- // encoding type.
- //
- // See below for a list of the predefined data structures.
- //--------------------------------------------------------------------------
- typedef LPVOID (WINAPI *PFN_CRYPT_ALLOC)(
- IN size_t cbSize
- );
- typedef VOID (WINAPI *PFN_CRYPT_FREE)(
- IN LPVOID pv
- );
- typedef struct _CRYPT_ENCODE_PARA {
- DWORD cbSize;
- PFN_CRYPT_ALLOC pfnAlloc; // OPTIONAL
- PFN_CRYPT_FREE pfnFree; // OPTIONAL
- } CRYPT_ENCODE_PARA, *PCRYPT_ENCODE_PARA;
- WINCRYPT32API
- BOOL
- WINAPI
- CryptEncodeObjectEx(
- IN DWORD dwCertEncodingType,
- IN LPCSTR lpszStructType,
- IN const void *pvStructInfo,
- IN DWORD dwFlags,
- IN OPTIONAL PCRYPT_ENCODE_PARA pEncodePara,
- OUT void *pvEncoded,
- IN OUT DWORD *pcbEncoded
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptEncodeObject(
- IN DWORD dwCertEncodingType,
- IN LPCSTR lpszStructType,
- IN const void *pvStructInfo,
- OUT BYTE *pbEncoded,
- IN OUT DWORD *pcbEncoded
- );
- // By default the signature bytes are reversed. The following flag can
- // be set to inhibit the byte reversal.
- //
- // This flag is applicable to
- // X509_CERT_TO_BE_SIGNED
- #define CRYPT_ENCODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG 0x8
- // When the following flag is set the called encode function allocates
- // memory for the encoded bytes. A pointer to the allocated bytes
- // is returned in pvEncoded. If pEncodePara or pEncodePara->pfnAlloc is
- // NULL, then, LocalAlloc is called for the allocation and LocalFree must
- // be called to do the free. Otherwise, pEncodePara->pfnAlloc is called
- // for the allocation.
- //
- // *pcbEncoded is ignored on input and updated with the length of the
- // allocated, encoded bytes.
- //
- // If pfnAlloc is set, then, pfnFree should also be set.
- #define CRYPT_ENCODE_ALLOC_FLAG 0x8000
- // The following flag is applicable when encoding X509_UNICODE_NAME.
- // When set, CERT_RDN_T61_STRING is selected instead of
- // CERT_RDN_UNICODE_STRING if all the unicode characters are <= 0xFF
- #define CRYPT_UNICODE_NAME_ENCODE_ENABLE_T61_UNICODE_FLAG \
- CERT_RDN_ENABLE_T61_UNICODE_FLAG
- // The following flag is applicable when encoding X509_UNICODE_NAME.
- // When set, CERT_RDN_UTF8_STRING is selected instead of
- // CERT_RDN_UNICODE_STRING.
- #define CRYPT_UNICODE_NAME_ENCODE_ENABLE_UTF8_UNICODE_FLAG \
- CERT_RDN_ENABLE_UTF8_UNICODE_FLAG
- // The following flag is applicable when encoding X509_UNICODE_NAME,
- // X509_UNICODE_NAME_VALUE or X509_UNICODE_ANY_STRING.
- // When set, the characters aren't checked to see if they
- // are valid for the specified Value Type.
- #define CRYPT_UNICODE_NAME_ENCODE_DISABLE_CHECK_TYPE_FLAG \
- CERT_RDN_DISABLE_CHECK_TYPE_FLAG
- // The following flag is applicable when encoding the PKCS_SORTED_CTL. This
- // flag should be set if the identifier for the TrustedSubjects is a hash,
- // such as, MD5 or SHA1.
- #define CRYPT_SORTED_CTL_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG 0x10000
- typedef struct _CRYPT_DECODE_PARA {
- DWORD cbSize;
- PFN_CRYPT_ALLOC pfnAlloc; // OPTIONAL
- PFN_CRYPT_FREE pfnFree; // OPTIONAL
- } CRYPT_DECODE_PARA, *PCRYPT_DECODE_PARA;
- WINCRYPT32API
- BOOL
- WINAPI
- CryptDecodeObjectEx(
- IN DWORD dwCertEncodingType,
- IN LPCSTR lpszStructType,
- IN const BYTE *pbEncoded,
- IN DWORD cbEncoded,
- IN DWORD dwFlags,
- IN OPTIONAL PCRYPT_DECODE_PARA pDecodePara,
- OUT OPTIONAL void *pvStructInfo,
- IN OUT DWORD *pcbStructInfo
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptDecodeObject(
- IN DWORD dwCertEncodingType,
- IN LPCSTR lpszStructType,
- IN const BYTE *pbEncoded,
- IN DWORD cbEncoded,
- IN DWORD dwFlags,
- OUT void *pvStructInfo,
- IN OUT DWORD *pcbStructInfo
- );
- // When the following flag is set the nocopy optimization is enabled.
- // This optimization where appropriate, updates the pvStructInfo fields
- // to point to content residing within pbEncoded instead of making a copy
- // of and appending to pvStructInfo.
- //
- // Note, when set, pbEncoded can't be freed until pvStructInfo is freed.
- #define CRYPT_DECODE_NOCOPY_FLAG 0x1
- // For CryptDecodeObject(), by default the pbEncoded is the "to be signed"
- // plus its signature. Set the following flag, if pbEncoded points to only
- // the "to be signed".
- //
- // This flag is applicable to
- // X509_CERT_TO_BE_SIGNED
- // X509_CERT_CRL_TO_BE_SIGNED
- // X509_CERT_REQUEST_TO_BE_SIGNED
- // X509_KEYGEN_REQUEST_TO_BE_SIGNED
- #define CRYPT_DECODE_TO_BE_SIGNED_FLAG 0x2
- // When the following flag is set, the OID strings are allocated in
- // crypt32.dll and shared instead of being copied into the returned
- // data structure. This flag may be set if crypt32.dll isn't unloaded
- // before the caller is unloaded.
- #define CRYPT_DECODE_SHARE_OID_STRING_FLAG 0x4
- // By default the signature bytes are reversed. The following flag can
- // be set to inhibit the byte reversal.
- //
- // This flag is applicable to
- // X509_CERT_TO_BE_SIGNED
- #define CRYPT_DECODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG 0x8
- // When the following flag is set the called decode function allocates
- // memory for the decoded structure. A pointer to the allocated structure
- // is returned in pvStructInfo. If pDecodePara or pDecodePara->pfnAlloc is
- // NULL, then, LocalAlloc is called for the allocation and LocalFree must
- // be called to do the free. Otherwise, pDecodePara->pfnAlloc is called
- // for the allocation.
- //
- // *pcbStructInfo is ignored on input and updated with the length of the
- // allocated, decoded structure.
- //
- // This flag may also be set in the CryptDecodeObject API. Since
- // CryptDecodeObject doesn't take a pDecodePara, LocalAlloc is always
- // called for the allocation which must be freed by calling LocalFree.
- #define CRYPT_DECODE_ALLOC_FLAG 0x8000
- // The following flag is applicable when decoding X509_UNICODE_NAME,
- // X509_UNICODE_NAME_VALUE or X509_UNICODE_ANY_STRING.
- // By default, CERT_RDN_T61_STRING values are initially decoded
- // as UTF8. If the UTF8 decoding fails, then, decoded as 8 bit characters.
- // Setting this flag skips the initial attempt to decode as UTF8.
- #define CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG \
- CERT_RDN_DISABLE_IE4_UTF8_FLAG
- //+-------------------------------------------------------------------------
- // Predefined X509 certificate data structures that can be encoded / decoded.
- //--------------------------------------------------------------------------
- #define CRYPT_ENCODE_DECODE_NONE 0
- #define X509_CERT ((LPCSTR) 1)
- #define X509_CERT_TO_BE_SIGNED ((LPCSTR) 2)
- #define X509_CERT_CRL_TO_BE_SIGNED ((LPCSTR) 3)
- #define X509_CERT_REQUEST_TO_BE_SIGNED ((LPCSTR) 4)
- #define X509_EXTENSIONS ((LPCSTR) 5)
- #define X509_NAME_VALUE ((LPCSTR) 6)
- #define X509_NAME ((LPCSTR) 7)
- #define X509_PUBLIC_KEY_INFO ((LPCSTR) 8)
- //+-------------------------------------------------------------------------
- // Predefined X509 certificate extension data structures that can be
- // encoded / decoded.
- //--------------------------------------------------------------------------
- #define X509_AUTHORITY_KEY_ID ((LPCSTR) 9)
- #define X509_KEY_ATTRIBUTES ((LPCSTR) 10)
- #define X509_KEY_USAGE_RESTRICTION ((LPCSTR) 11)
- #define X509_ALTERNATE_NAME ((LPCSTR) 12)
- #define X509_BASIC_CONSTRAINTS ((LPCSTR) 13)
- #define X509_KEY_USAGE ((LPCSTR) 14)
- #define X509_BASIC_CONSTRAINTS2 ((LPCSTR) 15)
- #define X509_CERT_POLICIES ((LPCSTR) 16)
- //+-------------------------------------------------------------------------
- // Additional predefined data structures that can be encoded / decoded.
- //--------------------------------------------------------------------------
- #define PKCS_UTC_TIME ((LPCSTR) 17)
- #define PKCS_TIME_REQUEST ((LPCSTR) 18)
- #define RSA_CSP_PUBLICKEYBLOB ((LPCSTR) 19)
- #define X509_UNICODE_NAME ((LPCSTR) 20)
- #define X509_KEYGEN_REQUEST_TO_BE_SIGNED ((LPCSTR) 21)
- #define PKCS_ATTRIBUTE ((LPCSTR) 22)
- #define PKCS_CONTENT_INFO_SEQUENCE_OF_ANY ((LPCSTR) 23)
- //+-------------------------------------------------------------------------
- // Predefined primitive data structures that can be encoded / decoded.
- //--------------------------------------------------------------------------
- #define X509_UNICODE_NAME_VALUE ((LPCSTR) 24)
- #define X509_ANY_STRING X509_NAME_VALUE
- #define X509_UNICODE_ANY_STRING X509_UNICODE_NAME_VALUE
- #define X509_OCTET_STRING ((LPCSTR) 25)
- #define X509_BITS ((LPCSTR) 26)
- #define X509_INTEGER ((LPCSTR) 27)
- #define X509_MULTI_BYTE_INTEGER ((LPCSTR) 28)
- #define X509_ENUMERATED ((LPCSTR) 29)
- #define X509_CHOICE_OF_TIME ((LPCSTR) 30)
- //+-------------------------------------------------------------------------
- // More predefined X509 certificate extension data structures that can be
- // encoded / decoded.
- //--------------------------------------------------------------------------
- #define X509_AUTHORITY_KEY_ID2 ((LPCSTR) 31)
- #define X509_AUTHORITY_INFO_ACCESS ((LPCSTR) 32)
- #define X509_CRL_REASON_CODE X509_ENUMERATED
- #define PKCS_CONTENT_INFO ((LPCSTR) 33)
- #define X509_SEQUENCE_OF_ANY ((LPCSTR) 34)
- #define X509_CRL_DIST_POINTS ((LPCSTR) 35)
- #define X509_ENHANCED_KEY_USAGE ((LPCSTR) 36)
- #define PKCS_CTL ((LPCSTR) 37)
- #define X509_MULTI_BYTE_UINT ((LPCSTR) 38)
- #define X509_DSS_PUBLICKEY X509_MULTI_BYTE_UINT
- #define X509_DSS_PARAMETERS ((LPCSTR) 39)
- #define X509_DSS_SIGNATURE ((LPCSTR) 40)
- #define PKCS_RC2_CBC_PARAMETERS ((LPCSTR) 41)
- #define PKCS_SMIME_CAPABILITIES ((LPCSTR) 42)
- //+-------------------------------------------------------------------------
- // data structures for private keys
- //--------------------------------------------------------------------------
- #define PKCS_RSA_PRIVATE_KEY ((LPCSTR) 43)
- #define PKCS_PRIVATE_KEY_INFO ((LPCSTR) 44)
- #define PKCS_ENCRYPTED_PRIVATE_KEY_INFO ((LPCSTR) 45)
- //+-------------------------------------------------------------------------
- // certificate policy qualifier
- //--------------------------------------------------------------------------
- #define X509_PKIX_POLICY_QUALIFIER_USERNOTICE ((LPCSTR) 46)
- //+-------------------------------------------------------------------------
- // Diffie-Hellman Key Exchange
- //--------------------------------------------------------------------------
- #define X509_DH_PUBLICKEY X509_MULTI_BYTE_UINT
- #define X509_DH_PARAMETERS ((LPCSTR) 47)
- #define PKCS_ATTRIBUTES ((LPCSTR) 48)
- #define PKCS_SORTED_CTL ((LPCSTR) 49)
- //+-------------------------------------------------------------------------
- // X942 Diffie-Hellman
- //--------------------------------------------------------------------------
- #define X942_DH_PARAMETERS ((LPCSTR) 50)
- //+-------------------------------------------------------------------------
- // The following is the same as X509_BITS, except before encoding,
- // the bit length is decremented to exclude trailing zero bits.
- //--------------------------------------------------------------------------
- #define X509_BITS_WITHOUT_TRAILING_ZEROES ((LPCSTR) 51)
- //+-------------------------------------------------------------------------
- // X942 Diffie-Hellman Other Info
- //--------------------------------------------------------------------------
- #define X942_OTHER_INFO ((LPCSTR) 52)
- #define X509_CERT_PAIR ((LPCSTR) 53)
- #define X509_ISSUING_DIST_POINT ((LPCSTR) 54)
- #define X509_NAME_CONSTRAINTS ((LPCSTR) 55)
- #define X509_POLICY_MAPPINGS ((LPCSTR) 56)
- #define X509_POLICY_CONSTRAINTS ((LPCSTR) 57)
- #define X509_CROSS_CERT_DIST_POINTS ((LPCSTR) 58)
- //+-------------------------------------------------------------------------
- // Certificate Management Messages over CMS (CMC) Data Structures
- //--------------------------------------------------------------------------
- #define CMC_DATA ((LPCSTR) 59)
- #define CMC_RESPONSE ((LPCSTR) 60)
- #define CMC_STATUS ((LPCSTR) 61)
- #define CMC_ADD_EXTENSIONS ((LPCSTR) 62)
- #define CMC_ADD_ATTRIBUTES ((LPCSTR) 63)
- //+-------------------------------------------------------------------------
- // Certificate Template
- //--------------------------------------------------------------------------
- #define X509_CERTIFICATE_TEMPLATE ((LPCSTR) 64)
- //+-------------------------------------------------------------------------
- // Predefined PKCS #7 data structures that can be encoded / decoded.
- //--------------------------------------------------------------------------
- #define PKCS7_SIGNER_INFO ((LPCSTR) 500)
- //+-------------------------------------------------------------------------
- // Predefined PKCS #7 data structures that can be encoded / decoded.
- //--------------------------------------------------------------------------
- #define CMS_SIGNER_INFO ((LPCSTR) 501)
- //+-------------------------------------------------------------------------
- // Predefined Software Publishing Credential (SPC) data structures that
- // can be encoded / decoded.
- //
- // Predefined values: 2000 .. 2999
- //
- // See spc.h for value and data structure definitions.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Extension Object Identifiers
- //--------------------------------------------------------------------------
- #define szOID_AUTHORITY_KEY_IDENTIFIER "2.5.29.1"
- #define szOID_KEY_ATTRIBUTES "2.5.29.2"
- #define szOID_CERT_POLICIES_95 "2.5.29.3"
- #define szOID_KEY_USAGE_RESTRICTION "2.5.29.4"
- #define szOID_SUBJECT_ALT_NAME "2.5.29.7"
- #define szOID_ISSUER_ALT_NAME "2.5.29.8"
- #define szOID_BASIC_CONSTRAINTS "2.5.29.10"
- #define szOID_KEY_USAGE "2.5.29.15"
- #define szOID_PRIVATEKEY_USAGE_PERIOD "2.5.29.16"
- #define szOID_BASIC_CONSTRAINTS2 "2.5.29.19"
- #define szOID_CERT_POLICIES "2.5.29.32"
- #define szOID_ANY_CERT_POLICY "2.5.29.32.0"
- #define szOID_AUTHORITY_KEY_IDENTIFIER2 "2.5.29.35"
- #define szOID_SUBJECT_KEY_IDENTIFIER "2.5.29.14"
- #define szOID_SUBJECT_ALT_NAME2 "2.5.29.17"
- #define szOID_ISSUER_ALT_NAME2 "2.5.29.18"
- #define szOID_CRL_REASON_CODE "2.5.29.21"
- #define szOID_REASON_CODE_HOLD "2.5.29.23"
- #define szOID_CRL_DIST_POINTS "2.5.29.31"
- #define szOID_ENHANCED_KEY_USAGE "2.5.29.37"
- // szOID_CRL_NUMBER -- Base CRLs only. Monotonically increasing sequence
- // number for each CRL issued by a CA.
- #define szOID_CRL_NUMBER "2.5.29.20"
- // szOID_DELTA_CRL_INDICATOR -- Delta CRLs only. Marked critical.
- // Contains the minimum base CRL Number that can be used with a delta CRL.
- #define szOID_DELTA_CRL_INDICATOR "2.5.29.27"
- #define szOID_ISSUING_DIST_POINT "2.5.29.28"
- // szOID_FRESHEST_CRL -- Base CRLs only. Formatted identically to a CDP
- // extension that holds URLs to fetch the delta CRL.
- #define szOID_FRESHEST_CRL "2.5.29.46"
- #define szOID_NAME_CONSTRAINTS "2.5.29.30"
- // Note on 1/1/2000 szOID_POLICY_MAPPINGS was changed from "2.5.29.5"
- #define szOID_POLICY_MAPPINGS "2.5.29.33"
- #define szOID_LEGACY_POLICY_MAPPINGS "2.5.29.5"
- #define szOID_POLICY_CONSTRAINTS "2.5.29.36"
- // Microsoft PKCS10 Attributes
- #define szOID_RENEWAL_CERTIFICATE "1.3.6.1.4.1.311.13.1"
- #define szOID_ENROLLMENT_NAME_VALUE_PAIR "1.3.6.1.4.1.311.13.2.1"
- #define szOID_ENROLLMENT_CSP_PROVIDER "1.3.6.1.4.1.311.13.2.2"
- #define szOID_OS_VERSION "1.3.6.1.4.1.311.13.2.3"
- //
- // Extension contain certificate type
- #define szOID_ENROLLMENT_AGENT "1.3.6.1.4.1.311.20.2.1"
- // Internet Public Key Infrastructure (PKIX)
- #define szOID_PKIX "1.3.6.1.5.5.7"
- #define szOID_PKIX_PE "1.3.6.1.5.5.7.1"
- #define szOID_AUTHORITY_INFO_ACCESS "1.3.6.1.5.5.7.1.1"
- // Microsoft extensions or attributes
- #define szOID_CERT_EXTENSIONS "1.3.6.1.4.1.311.2.1.14"
- #define szOID_NEXT_UPDATE_LOCATION "1.3.6.1.4.1.311.10.2"
- #define szOID_REMOVE_CERTIFICATE "1.3.6.1.4.1.311.10.8.1"
- #define szOID_CROSS_CERT_DIST_POINTS "1.3.6.1.4.1.311.10.9.1"
- // Microsoft PKCS #7 ContentType Object Identifiers
- #define szOID_CTL "1.3.6.1.4.1.311.10.1"
- // Microsoft Sorted CTL Extension Object Identifier
- #define szOID_SORTED_CTL "1.3.6.1.4.1.311.10.1.1"
- // serialized serial numbers for PRS
- #ifndef szOID_SERIALIZED
- #define szOID_SERIALIZED "1.3.6.1.4.1.311.10.3.3.1"
- #endif
- // UPN principal name in SubjectAltName
- #ifndef szOID_NT_PRINCIPAL_NAME
- #define szOID_NT_PRINCIPAL_NAME "1.3.6.1.4.1.311.20.2.3"
- #endif
- // Windows product update unauthenticated attribute
- #ifndef szOID_PRODUCT_UPDATE
- #define szOID_PRODUCT_UPDATE "1.3.6.1.4.1.311.31.1"
- #endif
- // CryptUI
- #define szOID_ANY_APPLICATION_POLICY "1.3.6.1.4.1.311.10.12.1"
- //+-------------------------------------------------------------------------
- // Object Identifiers for use with Auto Enrollment
- //--------------------------------------------------------------------------
- #define szOID_AUTO_ENROLL_CTL_USAGE "1.3.6.1.4.1.311.20.1"
- // Extension contain certificate type
- #define szOID_ENROLL_CERTTYPE_EXTENSION "1.3.6.1.4.1.311.20.2"
- #define szOID_CERT_MANIFOLD "1.3.6.1.4.1.311.20.3"
- //+-------------------------------------------------------------------------
- // Object Identifiers for use with the MS Certificate Server
- //--------------------------------------------------------------------------
- #ifndef szOID_CERTSRV_CA_VERSION
- #define szOID_CERTSRV_CA_VERSION "1.3.6.1.4.1.311.21.1"
- #endif
- // szOID_CERTSRV_PREVIOUS_CERT_HASH -- Contains the sha1 hash of the previous
- // version of the CA certificate.
- #define szOID_CERTSRV_PREVIOUS_CERT_HASH "1.3.6.1.4.1.311.21.2"
- // szOID_CRL_VIRTUAL_BASE -- Delta CRLs only. Contains the base CRL Number
- // of the corresponding base CRL.
- #define szOID_CRL_VIRTUAL_BASE "1.3.6.1.4.1.311.21.3"
- // szOID_CRL_NEXT_PUBLISH -- Contains the time when the next CRL is expected
- // to be published. This may be sooner than the CRL's NextUpdate field.
- #define szOID_CRL_NEXT_PUBLISH "1.3.6.1.4.1.311.21.4"
- // Enhanced Key Usage for CA encryption certificate
- #define szOID_KP_CA_EXCHANGE "1.3.6.1.4.1.311.21.5"
- // Enhanced Key Usage for key recovery agent certificate
- #define szOID_KP_KEY_RECOVERY_AGENT "1.3.6.1.4.1.311.21.6"
- // Certificate template extension (v2)
- #define szOID_CERTIFICATE_TEMPLATE "1.3.6.1.4.1.311.21.7"
- // The root oid for all enterprise specific oids
- #define szOID_ENTERPRISE_OID_ROOT "1.3.6.1.4.1.311.21.8"
- // Dummy signing Subject RDN
- #define szOID_RDN_DUMMY_SIGNER "1.3.6.1.4.1.311.21.9"
- // Application Policies extension -- same encoding as szOID_CERT_POLICIES
- #define szOID_APPLICATION_CERT_POLICIES "1.3.6.1.4.1.311.21.10"
- // Application Policy Mappings -- same encoding as szOID_POLICY_MAPPINGS
- #define szOID_APPLICATION_POLICY_MAPPINGS "1.3.6.1.4.1.311.21.11"
- // Application Policy Constraints -- same encoding as szOID_POLICY_CONSTRAINTS
- #define szOID_APPLICATION_POLICY_CONSTRAINTS "1.3.6.1.4.1.311.21.12"
- #define szOID_ARCHIVED_KEY_ATTR "1.3.6.1.4.1.311.21.13"
- #define szOID_CRL_SELF_CDP "1.3.6.1.4.1.311.21.14"
- // Requires all certificates below the root to have a non-empty intersecting
- // issuance certificate policy usage.
- #define szOID_REQUIRE_CERT_CHAIN_POLICY "1.3.6.1.4.1.311.21.15"
- #define szOID_ARCHIVED_KEY_CERT_HASH "1.3.6.1.4.1.311.21.16"
- #define szOID_ISSUED_CERT_HASH "1.3.6.1.4.1.311.21.17"
- // Enhanced key usage for DS email replication
- #define szOID_DS_EMAIL_REPLICATION "1.3.6.1.4.1.311.21.19"
- #define szOID_REQUEST_CLIENT_INFO "1.3.6.1.4.1.311.21.20"
- #define szOID_ENCRYPTED_KEY_HASH "1.3.6.1.4.1.311.21.21"
- #define szOID_CERTSRV_CROSSCA_VERSION "1.3.6.1.4.1.311.21.22"
- //+-------------------------------------------------------------------------
- // Object Identifiers for use with the MS Directory Service
- //--------------------------------------------------------------------------
- #define szOID_NTDS_REPLICATION "1.3.6.1.4.1.311.25.1"
- //+-------------------------------------------------------------------------
- // Extension Object Identifiers (currently not implemented)
- //--------------------------------------------------------------------------
- #define szOID_SUBJECT_DIR_ATTRS "2.5.29.9"
- //+-------------------------------------------------------------------------
- // Enhanced Key Usage (Purpose) Object Identifiers
- //--------------------------------------------------------------------------
- #define szOID_PKIX_KP "1.3.6.1.5.5.7.3"
- // Consistent key usage bits: DIGITAL_SIGNATURE, KEY_ENCIPHERMENT
- // or KEY_AGREEMENT
- #define szOID_PKIX_KP_SERVER_AUTH "1.3.6.1.5.5.7.3.1"
- // Consistent key usage bits: DIGITAL_SIGNATURE
- #define szOID_PKIX_KP_CLIENT_AUTH "1.3.6.1.5.5.7.3.2"
- // Consistent key usage bits: DIGITAL_SIGNATURE
- #define szOID_PKIX_KP_CODE_SIGNING "1.3.6.1.5.5.7.3.3"
- // Consistent key usage bits: DIGITAL_SIGNATURE, NON_REPUDIATION and/or
- // (KEY_ENCIPHERMENT or KEY_AGREEMENT)
- #define szOID_PKIX_KP_EMAIL_PROTECTION "1.3.6.1.5.5.7.3.4"
- // Consistent key usage bits: DIGITAL_SIGNATURE and/or
- // (KEY_ENCIPHERMENT or KEY_AGREEMENT)
- #define szOID_PKIX_KP_IPSEC_END_SYSTEM "1.3.6.1.5.5.7.3.5"
- // Consistent key usage bits: DIGITAL_SIGNATURE and/or
- // (KEY_ENCIPHERMENT or KEY_AGREEMENT)
- #define szOID_PKIX_KP_IPSEC_TUNNEL "1.3.6.1.5.5.7.3.6"
- // Consistent key usage bits: DIGITAL_SIGNATURE and/or
- // (KEY_ENCIPHERMENT or KEY_AGREEMENT)
- #define szOID_PKIX_KP_IPSEC_USER "1.3.6.1.5.5.7.3.7"
- // Consistent key usage bits: DIGITAL_SIGNATURE or NON_REPUDIATION
- #define szOID_PKIX_KP_TIMESTAMP_SIGNING "1.3.6.1.5.5.7.3.8"
- // IKE (Internet Key Exchange) Intermediate KP for an IPsec end entity.
- // Defined in draft-ietf-ipsec-pki-req-04.txt, December 14, 1999.
- #define szOID_IPSEC_KP_IKE_INTERMEDIATE "1.3.6.1.5.5.8.2.2"
- //+-------------------------------------------------------------------------
- // Microsoft Enhanced Key Usage (Purpose) Object Identifiers
- //+-------------------------------------------------------------------------
- // Signer of CTLs
- #define szOID_KP_CTL_USAGE_SIGNING "1.3.6.1.4.1.311.10.3.1"
- // Signer of TimeStamps
- #define szOID_KP_TIME_STAMP_SIGNING "1.3.6.1.4.1.311.10.3.2"
- #ifndef szOID_SERVER_GATED_CRYPTO
- #define szOID_SERVER_GATED_CRYPTO "1.3.6.1.4.1.311.10.3.3"
- #endif
- #ifndef szOID_SGC_NETSCAPE
- #define szOID_SGC_NETSCAPE "2.16.840.1.113730.4.1"
- #endif
- #define szOID_KP_EFS "1.3.6.1.4.1.311.10.3.4"
- #define szOID_EFS_RECOVERY "1.3.6.1.4.1.311.10.3.4.1"
- // Can use Windows Hardware Compatible (WHQL)
- #define szOID_WHQL_CRYPTO "1.3.6.1.4.1.311.10.3.5"
- // Signed by the NT5 build lab
- #define szOID_NT5_CRYPTO "1.3.6.1.4.1.311.10.3.6"
- // Signed by and OEM of WHQL
- #define szOID_OEM_WHQL_CRYPTO "1.3.6.1.4.1.311.10.3.7"
- // Signed by the Embedded NT
- #define szOID_EMBEDDED_NT_CRYPTO "1.3.6.1.4.1.311.10.3.8"
- // Signer of a CTL containing trusted roots
- #define szOID_ROOT_LIST_SIGNER "1.3.6.1.4.1.311.10.3.9"
- // Can sign cross-cert and subordinate CA requests with qualified
- // subordination (name constraints, policy mapping, etc.)
- #define szOID_KP_QUALIFIED_SUBORDINATION "1.3.6.1.4.1.311.10.3.10"
- // Can be used to encrypt/recover escrowed keys
- #define szOID_KP_KEY_RECOVERY "1.3.6.1.4.1.311.10.3.11"
- // Signer of documents
- #define szOID_KP_DOCUMENT_SIGNING "1.3.6.1.4.1.311.10.3.12"
- // The default WinVerifyTrust Authenticode policy is to treat all time stamped
- // signatures as being valid forever. This OID limits the valid lifetime of the
- // signature to the lifetime of the certificate. This allows timestamped
- // signatures to expire. Normally this OID will be used in conjunction with
- // szOID_PKIX_KP_CODE_SIGNING to indicate new time stamp semantics should be
- // used. Support for this OID was added in WXP.
- #define szOID_KP_LIFETIME_SIGNING "1.3.6.1.4.1.311.10.3.13"
- #define szOID_KP_MOBILE_DEVICE_SOFTWARE "1.3.6.1.4.1.311.10.3.14"
- #ifndef szOID_DRM
- #define szOID_DRM "1.3.6.1.4.1.311.10.5.1"
- #endif
- // Microsoft DRM EKU
- #ifndef szOID_DRM_INDIVIDUALIZATION
- #define szOID_DRM_INDIVIDUALIZATION "1.3.6.1.4.1.311.10.5.2"
- #endif
- #ifndef szOID_LICENSES
- #define szOID_LICENSES "1.3.6.1.4.1.311.10.6.1"
- #endif
- #ifndef szOID_LICENSE_SERVER
- #define szOID_LICENSE_SERVER "1.3.6.1.4.1.311.10.6.2"
- #endif
- #ifndef szOID_KP_SMARTCARD_LOGON
- #define szOID_KP_SMARTCARD_LOGON "1.3.6.1.4.1.311.20.2.2"
- #endif
- //+-------------------------------------------------------------------------
- // Microsoft Attribute Object Identifiers
- //+-------------------------------------------------------------------------
- #define szOID_YESNO_TRUST_ATTR "1.3.6.1.4.1.311.10.4.1"
- //+-------------------------------------------------------------------------
- // Qualifiers that may be part of the szOID_CERT_POLICIES and
- // szOID_CERT_POLICIES95 extensions
- //+-------------------------------------------------------------------------
- #define szOID_PKIX_POLICY_QUALIFIER_CPS "1.3.6.1.5.5.7.2.1"
- #define szOID_PKIX_POLICY_QUALIFIER_USERNOTICE "1.3.6.1.5.5.7.2.2"
- // OID for old qualifer
- #define szOID_CERT_POLICIES_95_QUALIFIER1 "2.16.840.1.113733.1.7.1.1"
- //+-------------------------------------------------------------------------
- // X509_CERT
- //
- // The "to be signed" encoded content plus its signature. The ToBeSigned
- // content is the CryptEncodeObject() output for one of the following:
- // X509_CERT_TO_BE_SIGNED, X509_CERT_CRL_TO_BE_SIGNED or
- // X509_CERT_REQUEST_TO_BE_SIGNED.
- //
- // pvStructInfo points to CERT_SIGNED_CONTENT_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_CERT_TO_BE_SIGNED
- //
- // pvStructInfo points to CERT_INFO.
- //
- // For CryptDecodeObject(), the pbEncoded is the "to be signed" plus its
- // signature (output of a X509_CERT CryptEncodeObject()).
- //
- // For CryptEncodeObject(), the pbEncoded is just the "to be signed".
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_CERT_CRL_TO_BE_SIGNED
- //
- // pvStructInfo points to CRL_INFO.
- //
- // For CryptDecodeObject(), the pbEncoded is the "to be signed" plus its
- // signature (output of a X509_CERT CryptEncodeObject()).
- //
- // For CryptEncodeObject(), the pbEncoded is just the "to be signed".
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_CERT_REQUEST_TO_BE_SIGNED
- //
- // pvStructInfo points to CERT_REQUEST_INFO.
- //
- // For CryptDecodeObject(), the pbEncoded is the "to be signed" plus its
- // signature (output of a X509_CERT CryptEncodeObject()).
- //
- // For CryptEncodeObject(), the pbEncoded is just the "to be signed".
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_EXTENSIONS
- // szOID_CERT_EXTENSIONS
- //
- // pvStructInfo points to following CERT_EXTENSIONS.
- //--------------------------------------------------------------------------
- typedef struct _CERT_EXTENSIONS {
- DWORD cExtension;
- PCERT_EXTENSION rgExtension;
- } CERT_EXTENSIONS, *PCERT_EXTENSIONS;
- //+-------------------------------------------------------------------------
- // X509_NAME_VALUE
- // X509_ANY_STRING
- //
- // pvStructInfo points to CERT_NAME_VALUE.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_UNICODE_NAME_VALUE
- // X509_UNICODE_ANY_STRING
- //
- // pvStructInfo points to CERT_NAME_VALUE.
- //
- // The name values are unicode strings.
- //
- // For CryptEncodeObject:
- // Value.pbData points to the unicode string.
- // If Value.cbData = 0, then, the unicode string is NULL terminated.
- // Otherwise, Value.cbData is the unicode string byte count. The byte count
- // is twice the character count.
- //
- // If the unicode string contains an invalid character for the specified
- // dwValueType, then, *pcbEncoded is updated with the unicode character
- // index of the first invalid character. LastError is set to:
- // CRYPT_E_INVALID_NUMERIC_STRING, CRYPT_E_INVALID_PRINTABLE_STRING or
- // CRYPT_E_INVALID_IA5_STRING.
- //
- // To disable the above check, either set CERT_RDN_DISABLE_CHECK_TYPE_FLAG
- // in dwValueType or set CRYPT_UNICODE_NAME_ENCODE_DISABLE_CHECK_TYPE_FLAG
- // in dwFlags passed to CryptEncodeObjectEx.
- //
- // The unicode string is converted before being encoded according to
- // the specified dwValueType. If dwValueType is set to 0, LastError
- // is set to E_INVALIDARG.
- //
- // If the dwValueType isn't one of the character strings (its a
- // CERT_RDN_ENCODED_BLOB or CERT_RDN_OCTET_STRING), then, CryptEncodeObject
- // will return FALSE with LastError set to CRYPT_E_NOT_CHAR_STRING.
- //
- // For CryptDecodeObject:
- // Value.pbData points to a NULL terminated unicode string. Value.cbData
- // contains the byte count of the unicode string excluding the NULL
- // terminator. dwValueType contains the type used in the encoded object.
- // Its not forced to CERT_RDN_UNICODE_STRING. The encoded value is
- // converted to the unicode string according to the dwValueType.
- //
- // If the encoded object isn't one of the character string types, then,
- // CryptDecodeObject will return FALSE with LastError set to
- // CRYPT_E_NOT_CHAR_STRING. For a non character string, decode using
- // X509_NAME_VALUE or X509_ANY_STRING.
- //
- // By default, CERT_RDN_T61_STRING values are initially decoded
- // as UTF8. If the UTF8 decoding fails, then, decoded as 8 bit characters.
- // Set CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG in dwFlags
- // passed to either CryptDecodeObject or CryptDecodeObjectEx to
- // skip the initial attempt to decode as UTF8.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_NAME
- //
- // pvStructInfo points to CERT_NAME_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_UNICODE_NAME
- //
- // pvStructInfo points to CERT_NAME_INFO.
- //
- // The RDN attribute values are unicode strings except for the dwValueTypes of
- // CERT_RDN_ENCODED_BLOB or CERT_RDN_OCTET_STRING. These dwValueTypes are
- // the same as for a X509_NAME. Their values aren't converted to/from unicode.
- //
- // For CryptEncodeObject:
- // Value.pbData points to the unicode string.
- // If Value.cbData = 0, then, the unicode string is NULL terminated.
- // Otherwise, Value.cbData is the unicode string byte count. The byte count
- // is twice the character count.
- //
- // If dwValueType = 0 (CERT_RDN_ANY_TYPE), the pszObjId is used to find
- // an acceptable dwValueType. If the unicode string contains an
- // invalid character for the found or specified dwValueType, then,
- // *pcbEncoded is updated with the error location of the invalid character.
- // See below for details. LastError is set to:
- // CRYPT_E_INVALID_NUMERIC_STRING, CRYPT_E_INVALID_PRINTABLE_STRING or
- // CRYPT_E_INVALID_IA5_STRING.
- //
- // To disable the above check, either set CERT_RDN_DISABLE_CHECK_TYPE_FLAG
- // in dwValueType or set CRYPT_UNICODE_NAME_ENCODE_DISABLE_CHECK_TYPE_FLAG
- // in dwFlags passed to CryptEncodeObjectEx.
- //
- // Set CERT_RDN_UNICODE_STRING in dwValueType or set
- // CRYPT_UNICODE_NAME_ENCODE_ENABLE_T61_UNICODE_FLAG in dwFlags passed
- // to CryptEncodeObjectEx to select CERT_RDN_T61_STRING instead of
- // CERT_RDN_UNICODE_STRING if all the unicode characters are <= 0xFF.
- //
- // Set CERT_RDN_ENABLE_UTF8_UNICODE_STRING in dwValueType or set
- // CRYPT_UNICODE_NAME_ENCODE_ENABLE_UTF8_UNICODE_FLAG in dwFlags passed
- // to CryptEncodeObjectEx to select CERT_RDN_UTF8_STRING instead of
- // CERT_RDN_UNICODE_STRING.
- //
- // The unicode string is converted before being encoded according to
- // the specified or ObjId matching dwValueType.
- //
- // For CryptDecodeObject:
- // Value.pbData points to a NULL terminated unicode string. Value.cbData
- // contains the byte count of the unicode string excluding the NULL
- // terminator. dwValueType contains the type used in the encoded object.
- // Its not forced to CERT_RDN_UNICODE_STRING. The encoded value is
- // converted to the unicode string according to the dwValueType.
- //
- // If the dwValueType of the encoded value isn't a character string
- // type, then, it isn't converted to UNICODE. Use the
- // IS_CERT_RDN_CHAR_STRING() macro on the dwValueType to check
- // that Value.pbData points to a converted unicode string.
- //
- // By default, CERT_RDN_T61_STRING values are initially decoded
- // as UTF8. If the UTF8 decoding fails, then, decoded as 8 bit characters.
- // Set CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG in dwFlags
- // passed to either CryptDecodeObject or CryptDecodeObjectEx to
- // skip the initial attempt to decode as UTF8.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Unicode Name Value Error Location Definitions
- //
- // Error location is returned in *pcbEncoded by
- // CryptEncodeObject(X509_UNICODE_NAME)
- //
- // Error location consists of:
- // RDN_INDEX - 10 bits << 22
- // ATTR_INDEX - 6 bits << 16
- // VALUE_INDEX - 16 bits (unicode character index)
- //--------------------------------------------------------------------------
- #define CERT_UNICODE_RDN_ERR_INDEX_MASK 0x3FF
- #define CERT_UNICODE_RDN_ERR_INDEX_SHIFT 22
- #define CERT_UNICODE_ATTR_ERR_INDEX_MASK 0x003F
- #define CERT_UNICODE_ATTR_ERR_INDEX_SHIFT 16
- #define CERT_UNICODE_VALUE_ERR_INDEX_MASK 0x0000FFFF
- #define CERT_UNICODE_VALUE_ERR_INDEX_SHIFT 0
- #define GET_CERT_UNICODE_RDN_ERR_INDEX(X) \
- ((X >> CERT_UNICODE_RDN_ERR_INDEX_SHIFT) & CERT_UNICODE_RDN_ERR_INDEX_MASK)
- #define GET_CERT_UNICODE_ATTR_ERR_INDEX(X) \
- ((X >> CERT_UNICODE_ATTR_ERR_INDEX_SHIFT) & CERT_UNICODE_ATTR_ERR_INDEX_MASK)
- #define GET_CERT_UNICODE_VALUE_ERR_INDEX(X) \
- (X & CERT_UNICODE_VALUE_ERR_INDEX_MASK)
- //+-------------------------------------------------------------------------
- // X509_PUBLIC_KEY_INFO
- //
- // pvStructInfo points to CERT_PUBLIC_KEY_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_AUTHORITY_KEY_ID
- // szOID_AUTHORITY_KEY_IDENTIFIER
- //
- // pvStructInfo points to following CERT_AUTHORITY_KEY_ID_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_AUTHORITY_KEY_ID_INFO {
- CRYPT_DATA_BLOB KeyId;
- CERT_NAME_BLOB CertIssuer;
- CRYPT_INTEGER_BLOB CertSerialNumber;
- } CERT_AUTHORITY_KEY_ID_INFO, *PCERT_AUTHORITY_KEY_ID_INFO;
- //+-------------------------------------------------------------------------
- // X509_KEY_ATTRIBUTES
- // szOID_KEY_ATTRIBUTES
- //
- // pvStructInfo points to following CERT_KEY_ATTRIBUTES_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_PRIVATE_KEY_VALIDITY {
- FILETIME NotBefore;
- FILETIME NotAfter;
- } CERT_PRIVATE_KEY_VALIDITY, *PCERT_PRIVATE_KEY_VALIDITY;
- typedef struct _CERT_KEY_ATTRIBUTES_INFO {
- CRYPT_DATA_BLOB KeyId;
- CRYPT_BIT_BLOB IntendedKeyUsage;
- PCERT_PRIVATE_KEY_VALIDITY pPrivateKeyUsagePeriod; // OPTIONAL
- } CERT_KEY_ATTRIBUTES_INFO, *PCERT_KEY_ATTRIBUTES_INFO;
- // Byte[0]
- #define CERT_DIGITAL_SIGNATURE_KEY_USAGE 0x80
- #define CERT_NON_REPUDIATION_KEY_USAGE 0x40
- #define CERT_KEY_ENCIPHERMENT_KEY_USAGE 0x20
- #define CERT_DATA_ENCIPHERMENT_KEY_USAGE 0x10
- #define CERT_KEY_AGREEMENT_KEY_USAGE 0x08
- #define CERT_KEY_CERT_SIGN_KEY_USAGE 0x04
- #define CERT_OFFLINE_CRL_SIGN_KEY_USAGE 0x02
- #define CERT_CRL_SIGN_KEY_USAGE 0x02
- #define CERT_ENCIPHER_ONLY_KEY_USAGE 0x01
- // Byte[1]
- #define CERT_DECIPHER_ONLY_KEY_USAGE 0x80
- //+-------------------------------------------------------------------------
- // X509_KEY_USAGE_RESTRICTION
- // szOID_KEY_USAGE_RESTRICTION
- //
- // pvStructInfo points to following CERT_KEY_USAGE_RESTRICTION_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_POLICY_ID {
- DWORD cCertPolicyElementId;
- LPSTR *rgpszCertPolicyElementId; // pszObjId
- } CERT_POLICY_ID, *PCERT_POLICY_ID;
- typedef struct _CERT_KEY_USAGE_RESTRICTION_INFO {
- DWORD cCertPolicyId;
- PCERT_POLICY_ID rgCertPolicyId;
- CRYPT_BIT_BLOB RestrictedKeyUsage;
- } CERT_KEY_USAGE_RESTRICTION_INFO, *PCERT_KEY_USAGE_RESTRICTION_INFO;
- // See CERT_KEY_ATTRIBUTES_INFO for definition of the RestrictedKeyUsage bits
- //+-------------------------------------------------------------------------
- // X509_ALTERNATE_NAME
- // szOID_SUBJECT_ALT_NAME
- // szOID_ISSUER_ALT_NAME
- // szOID_SUBJECT_ALT_NAME2
- // szOID_ISSUER_ALT_NAME2
- //
- // pvStructInfo points to following CERT_ALT_NAME_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_OTHER_NAME {
- LPSTR pszObjId;
- CRYPT_OBJID_BLOB Value;
- } CERT_OTHER_NAME, *PCERT_OTHER_NAME;
- typedef struct _CERT_ALT_NAME_ENTRY {
- DWORD dwAltNameChoice;
- union {
- PCERT_OTHER_NAME pOtherName; // 1
- LPWSTR pwszRfc822Name; // 2 (encoded IA5)
- LPWSTR pwszDNSName; // 3 (encoded IA5)
- // Not implemented x400Address; // 4
- CERT_NAME_BLOB DirectoryName; // 5
- // Not implemented pEdiPartyName; // 6
- LPWSTR pwszURL; // 7 (encoded IA5)
- CRYPT_DATA_BLOB IPAddress; // 8 (Octet String)
- LPSTR pszRegisteredID; // 9 (Object Identifer)
- };
- } CERT_ALT_NAME_ENTRY, *PCERT_ALT_NAME_ENTRY;
- #define CERT_ALT_NAME_OTHER_NAME 1
- #define CERT_ALT_NAME_RFC822_NAME 2
- #define CERT_ALT_NAME_DNS_NAME 3
- #define CERT_ALT_NAME_X400_ADDRESS 4
- #define CERT_ALT_NAME_DIRECTORY_NAME 5
- #define CERT_ALT_NAME_EDI_PARTY_NAME 6
- #define CERT_ALT_NAME_URL 7
- #define CERT_ALT_NAME_IP_ADDRESS 8
- #define CERT_ALT_NAME_REGISTERED_ID 9
- typedef struct _CERT_ALT_NAME_INFO {
- DWORD cAltEntry;
- PCERT_ALT_NAME_ENTRY rgAltEntry;
- } CERT_ALT_NAME_INFO, *PCERT_ALT_NAME_INFO;
- //+-------------------------------------------------------------------------
- // Alternate name IA5 Error Location Definitions for
- // CRYPT_E_INVALID_IA5_STRING.
- //
- // Error location is returned in *pcbEncoded by
- // CryptEncodeObject(X509_ALTERNATE_NAME)
- //
- // Error location consists of:
- // ENTRY_INDEX - 8 bits << 16
- // VALUE_INDEX - 16 bits (unicode character index)
- //--------------------------------------------------------------------------
- #define CERT_ALT_NAME_ENTRY_ERR_INDEX_MASK 0xFF
- #define CERT_ALT_NAME_ENTRY_ERR_INDEX_SHIFT 16
- #define CERT_ALT_NAME_VALUE_ERR_INDEX_MASK 0x0000FFFF
- #define CERT_ALT_NAME_VALUE_ERR_INDEX_SHIFT 0
- #define GET_CERT_ALT_NAME_ENTRY_ERR_INDEX(X) \
- ((X >> CERT_ALT_NAME_ENTRY_ERR_INDEX_SHIFT) & \
- CERT_ALT_NAME_ENTRY_ERR_INDEX_MASK)
- #define GET_CERT_ALT_NAME_VALUE_ERR_INDEX(X) \
- (X & CERT_ALT_NAME_VALUE_ERR_INDEX_MASK)
- //+-------------------------------------------------------------------------
- // X509_BASIC_CONSTRAINTS
- // szOID_BASIC_CONSTRAINTS
- //
- // pvStructInfo points to following CERT_BASIC_CONSTRAINTS_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_BASIC_CONSTRAINTS_INFO {
- CRYPT_BIT_BLOB SubjectType;
- BOOL fPathLenConstraint;
- DWORD dwPathLenConstraint;
- DWORD cSubtreesConstraint;
- CERT_NAME_BLOB *rgSubtreesConstraint;
- } CERT_BASIC_CONSTRAINTS_INFO, *PCERT_BASIC_CONSTRAINTS_INFO;
- #define CERT_CA_SUBJECT_FLAG 0x80
- #define CERT_END_ENTITY_SUBJECT_FLAG 0x40
- //+-------------------------------------------------------------------------
- // X509_BASIC_CONSTRAINTS2
- // szOID_BASIC_CONSTRAINTS2
- //
- // pvStructInfo points to following CERT_BASIC_CONSTRAINTS2_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_BASIC_CONSTRAINTS2_INFO {
- BOOL fCA;
- BOOL fPathLenConstraint;
- DWORD dwPathLenConstraint;
- } CERT_BASIC_CONSTRAINTS2_INFO, *PCERT_BASIC_CONSTRAINTS2_INFO;
- //+-------------------------------------------------------------------------
- // X509_KEY_USAGE
- // szOID_KEY_USAGE
- //
- // pvStructInfo points to a CRYPT_BIT_BLOB. Has same bit definitions as
- // CERT_KEY_ATTRIBUTES_INFO's IntendedKeyUsage.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_CERT_POLICIES
- // szOID_CERT_POLICIES
- // szOID_CERT_POLICIES_95 NOTE--Only allowed for decoding!!!
- //
- // pvStructInfo points to following CERT_POLICIES_INFO.
- //
- // NOTE: when decoding using szOID_CERT_POLICIES_95 the pszPolicyIdentifier
- // may contain an empty string
- //--------------------------------------------------------------------------
- typedef struct _CERT_POLICY_QUALIFIER_INFO {
- LPSTR pszPolicyQualifierId; // pszObjId
- CRYPT_OBJID_BLOB Qualifier; // optional
- } CERT_POLICY_QUALIFIER_INFO, *PCERT_POLICY_QUALIFIER_INFO;
- typedef struct _CERT_POLICY_INFO {
- LPSTR pszPolicyIdentifier; // pszObjId
- DWORD cPolicyQualifier; // optional
- CERT_POLICY_QUALIFIER_INFO *rgPolicyQualifier;
- } CERT_POLICY_INFO, *PCERT_POLICY_INFO;
- typedef struct _CERT_POLICIES_INFO {
- DWORD cPolicyInfo;
- CERT_POLICY_INFO *rgPolicyInfo;
- } CERT_POLICIES_INFO, *PCERT_POLICIES_INFO;
- //+-------------------------------------------------------------------------
- // X509_PKIX_POLICY_QUALIFIER_USERNOTICE
- // szOID_PKIX_POLICY_QUALIFIER_USERNOTICE
- //
- // pvStructInfo points to following CERT_POLICY_QUALIFIER_USER_NOTICE.
- //
- //--------------------------------------------------------------------------
- typedef struct _CERT_POLICY_QUALIFIER_NOTICE_REFERENCE {
- LPSTR pszOrganization;
- DWORD cNoticeNumbers;
- int *rgNoticeNumbers;
- } CERT_POLICY_QUALIFIER_NOTICE_REFERENCE, *PCERT_POLICY_QUALIFIER_NOTICE_REFERENCE;
- typedef struct _CERT_POLICY_QUALIFIER_USER_NOTICE {
- CERT_POLICY_QUALIFIER_NOTICE_REFERENCE *pNoticeReference; // optional
- LPWSTR pszDisplayText; // optional
- } CERT_POLICY_QUALIFIER_USER_NOTICE, *PCERT_POLICY_QUALIFIER_USER_NOTICE;
- //+-------------------------------------------------------------------------
- // szOID_CERT_POLICIES_95_QUALIFIER1 - Decode Only!!!!
- //
- // pvStructInfo points to following CERT_POLICY95_QUALIFIER1.
- //
- //--------------------------------------------------------------------------
- typedef struct _CPS_URLS {
- LPWSTR pszURL;
- CRYPT_ALGORITHM_IDENTIFIER *pAlgorithm; // optional
- CRYPT_DATA_BLOB *pDigest; // optional
- } CPS_URLS, *PCPS_URLS;
- typedef struct _CERT_POLICY95_QUALIFIER1 {
- LPWSTR pszPracticesReference; // optional
- LPSTR pszNoticeIdentifier; // optional
- LPSTR pszNSINoticeIdentifier; // optional
- DWORD cCPSURLs;
- CPS_URLS *rgCPSURLs; // optional
- } CERT_POLICY95_QUALIFIER1, *PCERT_POLICY95_QUALIFIER1;
- //+-------------------------------------------------------------------------
- // X509_POLICY_MAPPINGS
- // szOID_POLICY_MAPPINGS
- // szOID_LEGACY_POLICY_MAPPINGS
- //
- // pvStructInfo points to following CERT_POLICY_MAPPINGS_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_POLICY_MAPPING {
- LPSTR pszIssuerDomainPolicy; // pszObjId
- LPSTR pszSubjectDomainPolicy; // pszObjId
- } CERT_POLICY_MAPPING, *PCERT_POLICY_MAPPING;
- typedef struct _CERT_POLICY_MAPPINGS_INFO {
- DWORD cPolicyMapping;
- PCERT_POLICY_MAPPING rgPolicyMapping;
- } CERT_POLICY_MAPPINGS_INFO, *PCERT_POLICY_MAPPINGS_INFO;
- //+-------------------------------------------------------------------------
- // X509_POLICY_CONSTRAINTS
- // szOID_POLICY_CONSTRAINTS
- //
- // pvStructInfo points to following CERT_POLICY_CONSTRAINTS_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CERT_POLICY_CONSTRAINTS_INFO {
- BOOL fRequireExplicitPolicy;
- DWORD dwRequireExplicitPolicySkipCerts;
- BOOL fInhibitPolicyMapping;
- DWORD dwInhibitPolicyMappingSkipCerts;
- } CERT_POLICY_CONSTRAINTS_INFO, *PCERT_POLICY_CONSTRAINTS_INFO;
- //+-------------------------------------------------------------------------
- // RSA_CSP_PUBLICKEYBLOB
- //
- // pvStructInfo points to a PUBLICKEYSTRUC immediately followed by a
- // RSAPUBKEY and the modulus bytes.
- //
- // CryptExportKey outputs the above StructInfo for a dwBlobType of
- // PUBLICKEYBLOB. CryptImportKey expects the above StructInfo when
- // importing a public key.
- //
- // For dwCertEncodingType = X509_ASN_ENCODING, the RSA_CSP_PUBLICKEYBLOB is
- // encoded as a PKCS #1 RSAPublicKey consisting of a SEQUENCE of a
- // modulus INTEGER and a publicExponent INTEGER. The modulus is encoded
- // as being a unsigned integer. When decoded, if the modulus was encoded
- // as unsigned integer with a leading 0 byte, the 0 byte is removed before
- // converting to the CSP modulus bytes.
- //
- // For decode, the aiKeyAlg field of PUBLICKEYSTRUC is always set to
- // CALG_RSA_KEYX.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_KEYGEN_REQUEST_TO_BE_SIGNED
- //
- // pvStructInfo points to CERT_KEYGEN_REQUEST_INFO.
- //
- // For CryptDecodeObject(), the pbEncoded is the "to be signed" plus its
- // signature (output of a X509_CERT CryptEncodeObject()).
- //
- // For CryptEncodeObject(), the pbEncoded is just the "to be signed".
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // PKCS_ATTRIBUTE data structure
- //
- // pvStructInfo points to a CRYPT_ATTRIBUTE.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // PKCS_ATTRIBUTES data structure
- //
- // pvStructInfo points to a CRYPT_ATTRIBUTES.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // PKCS_CONTENT_INFO_SEQUENCE_OF_ANY data structure
- //
- // pvStructInfo points to following CRYPT_CONTENT_INFO_SEQUENCE_OF_ANY.
- //
- // For X509_ASN_ENCODING: encoded as a PKCS#7 ContentInfo structure wrapping
- // a sequence of ANY. The value of the contentType field is pszObjId,
- // while the content field is the following structure:
- // SequenceOfAny ::= SEQUENCE OF ANY
- //
- // The CRYPT_DER_BLOBs point to the already encoded ANY content.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_CONTENT_INFO_SEQUENCE_OF_ANY {
- LPSTR pszObjId;
- DWORD cValue;
- PCRYPT_DER_BLOB rgValue;
- } CRYPT_CONTENT_INFO_SEQUENCE_OF_ANY, *PCRYPT_CONTENT_INFO_SEQUENCE_OF_ANY;
- //+-------------------------------------------------------------------------
- // PKCS_CONTENT_INFO data structure
- //
- // pvStructInfo points to following CRYPT_CONTENT_INFO.
- //
- // For X509_ASN_ENCODING: encoded as a PKCS#7 ContentInfo structure.
- // The CRYPT_DER_BLOB points to the already encoded ANY content.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_CONTENT_INFO {
- LPSTR pszObjId;
- CRYPT_DER_BLOB Content;
- } CRYPT_CONTENT_INFO, *PCRYPT_CONTENT_INFO;
- //+-------------------------------------------------------------------------
- // X509_OCTET_STRING data structure
- //
- // pvStructInfo points to a CRYPT_DATA_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_BITS data structure
- //
- // pvStructInfo points to a CRYPT_BIT_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_BITS_WITHOUT_TRAILING_ZEROES data structure
- //
- // pvStructInfo points to a CRYPT_BIT_BLOB.
- //
- // The same as X509_BITS, except before encoding, the bit length is
- // decremented to exclude trailing zero bits.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_INTEGER data structure
- //
- // pvStructInfo points to an int.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_MULTI_BYTE_INTEGER data structure
- //
- // pvStructInfo points to a CRYPT_INTEGER_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_ENUMERATED data structure
- //
- // pvStructInfo points to an int containing the enumerated value
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_CHOICE_OF_TIME data structure
- //
- // pvStructInfo points to a FILETIME.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_SEQUENCE_OF_ANY data structure
- //
- // pvStructInfo points to following CRYPT_SEQUENCE_OF_ANY.
- //
- // The CRYPT_DER_BLOBs point to the already encoded ANY content.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_SEQUENCE_OF_ANY {
- DWORD cValue;
- PCRYPT_DER_BLOB rgValue;
- } CRYPT_SEQUENCE_OF_ANY, *PCRYPT_SEQUENCE_OF_ANY;
- //+-------------------------------------------------------------------------
- // X509_AUTHORITY_KEY_ID2
- // szOID_AUTHORITY_KEY_IDENTIFIER2
- //
- // pvStructInfo points to following CERT_AUTHORITY_KEY_ID2_INFO.
- //
- // For CRYPT_E_INVALID_IA5_STRING, the error location is returned in
- // *pcbEncoded by CryptEncodeObject(X509_AUTHORITY_KEY_ID2)
- //
- // See X509_ALTERNATE_NAME for error location defines.
- //--------------------------------------------------------------------------
- typedef struct _CERT_AUTHORITY_KEY_ID2_INFO {
- CRYPT_DATA_BLOB KeyId;
- CERT_ALT_NAME_INFO AuthorityCertIssuer; // Optional, set cAltEntry
- // to 0 to omit.
- CRYPT_INTEGER_BLOB AuthorityCertSerialNumber;
- } CERT_AUTHORITY_KEY_ID2_INFO, *PCERT_AUTHORITY_KEY_ID2_INFO;
- //+-------------------------------------------------------------------------
- // szOID_SUBJECT_KEY_IDENTIFIER
- //
- // pvStructInfo points to a CRYPT_DATA_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_AUTHORITY_INFO_ACCESS
- // szOID_AUTHORITY_INFO_ACCESS
- //
- // pvStructInfo points to following CERT_AUTHORITY_INFO_ACCESS.
- //
- // For CRYPT_E_INVALID_IA5_STRING, the error location is returned in
- // *pcbEncoded by CryptEncodeObject(X509_AUTHORITY_INFO_ACCESS)
- //
- // Error location consists of:
- // ENTRY_INDEX - 8 bits << 16
- // VALUE_INDEX - 16 bits (unicode character index)
- //
- // See X509_ALTERNATE_NAME for ENTRY_INDEX and VALUE_INDEX error location
- // defines.
- //--------------------------------------------------------------------------
- typedef struct _CERT_ACCESS_DESCRIPTION {
- LPSTR pszAccessMethod; // pszObjId
- CERT_ALT_NAME_ENTRY AccessLocation;
- } CERT_ACCESS_DESCRIPTION, *PCERT_ACCESS_DESCRIPTION;
- typedef struct _CERT_AUTHORITY_INFO_ACCESS {
- DWORD cAccDescr;
- PCERT_ACCESS_DESCRIPTION rgAccDescr;
- } CERT_AUTHORITY_INFO_ACCESS, *PCERT_AUTHORITY_INFO_ACCESS;
- //+-------------------------------------------------------------------------
- // PKIX Access Description: Access Method Object Identifiers
- //--------------------------------------------------------------------------
- #define szOID_PKIX_ACC_DESCR "1.3.6.1.5.5.7.48"
- #define szOID_PKIX_OCSP "1.3.6.1.5.5.7.48.1"
- #define szOID_PKIX_CA_ISSUERS "1.3.6.1.5.5.7.48.2"
- //+-------------------------------------------------------------------------
- // X509_CRL_REASON_CODE
- // szOID_CRL_REASON_CODE
- //
- // pvStructInfo points to an int which can be set to one of the following
- // enumerated values:
- //--------------------------------------------------------------------------
- #define CRL_REASON_UNSPECIFIED 0
- #define CRL_REASON_KEY_COMPROMISE 1
- #define CRL_REASON_CA_COMPROMISE 2
- #define CRL_REASON_AFFILIATION_CHANGED 3
- #define CRL_REASON_SUPERSEDED 4
- #define CRL_REASON_CESSATION_OF_OPERATION 5
- #define CRL_REASON_CERTIFICATE_HOLD 6
- #define CRL_REASON_REMOVE_FROM_CRL 8
- //+-------------------------------------------------------------------------
- // X509_CRL_DIST_POINTS
- // szOID_CRL_DIST_POINTS
- //
- // pvStructInfo points to following CRL_DIST_POINTS_INFO.
- //
- // For CRYPT_E_INVALID_IA5_STRING, the error location is returned in
- // *pcbEncoded by CryptEncodeObject(X509_CRL_DIST_POINTS)
- //
- // Error location consists of:
- // CRL_ISSUER_BIT - 1 bit << 31 (0 for FullName, 1 for CRLIssuer)
- // POINT_INDEX - 7 bits << 24
- // ENTRY_INDEX - 8 bits << 16
- // VALUE_INDEX - 16 bits (unicode character index)
- //
- // See X509_ALTERNATE_NAME for ENTRY_INDEX and VALUE_INDEX error location
- // defines.
- //--------------------------------------------------------------------------
- typedef struct _CRL_DIST_POINT_NAME {
- DWORD dwDistPointNameChoice;
- union {
- CERT_ALT_NAME_INFO FullName; // 1
- // Not implemented IssuerRDN; // 2
- };
- } CRL_DIST_POINT_NAME, *PCRL_DIST_POINT_NAME;
- #define CRL_DIST_POINT_NO_NAME 0
- #define CRL_DIST_POINT_FULL_NAME 1
- #define CRL_DIST_POINT_ISSUER_RDN_NAME 2
- typedef struct _CRL_DIST_POINT {
- CRL_DIST_POINT_NAME DistPointName; // OPTIONAL
- CRYPT_BIT_BLOB ReasonFlags; // OPTIONAL
- CERT_ALT_NAME_INFO CRLIssuer; // OPTIONAL
- } CRL_DIST_POINT, *PCRL_DIST_POINT;
- #define CRL_REASON_UNUSED_FLAG 0x80
- #define CRL_REASON_KEY_COMPROMISE_FLAG 0x40
- #define CRL_REASON_CA_COMPROMISE_FLAG 0x20
- #define CRL_REASON_AFFILIATION_CHANGED_FLAG 0x10
- #define CRL_REASON_SUPERSEDED_FLAG 0x08
- #define CRL_REASON_CESSATION_OF_OPERATION_FLAG 0x04
- #define CRL_REASON_CERTIFICATE_HOLD_FLAG 0x02
- typedef struct _CRL_DIST_POINTS_INFO {
- DWORD cDistPoint;
- PCRL_DIST_POINT rgDistPoint;
- } CRL_DIST_POINTS_INFO, *PCRL_DIST_POINTS_INFO;
- #define CRL_DIST_POINT_ERR_INDEX_MASK 0x7F
- #define CRL_DIST_POINT_ERR_INDEX_SHIFT 24
- #define GET_CRL_DIST_POINT_ERR_INDEX(X) \
- ((X >> CRL_DIST_POINT_ERR_INDEX_SHIFT) & CRL_DIST_POINT_ERR_INDEX_MASK)
- #define CRL_DIST_POINT_ERR_CRL_ISSUER_BIT 0x80000000L
- #define IS_CRL_DIST_POINT_ERR_CRL_ISSUER(X) \
- (0 != (X & CRL_DIST_POINT_ERR_CRL_ISSUER_BIT))
- //+-------------------------------------------------------------------------
- // X509_CROSS_CERT_DIST_POINTS
- // szOID_CROSS_CERT_DIST_POINTS
- //
- // pvStructInfo points to following CROSS_CERT_DIST_POINTS_INFO.
- //
- // For CRYPT_E_INVALID_IA5_STRING, the error location is returned in
- // *pcbEncoded by CryptEncodeObject(X509_CRL_DIST_POINTS)
- //
- // Error location consists of:
- // POINT_INDEX - 8 bits << 24
- // ENTRY_INDEX - 8 bits << 16
- // VALUE_INDEX - 16 bits (unicode character index)
- //
- // See X509_ALTERNATE_NAME for ENTRY_INDEX and VALUE_INDEX error location
- // defines.
- //--------------------------------------------------------------------------
- typedef struct _CROSS_CERT_DIST_POINTS_INFO {
- // Seconds between syncs. 0 implies use client default.
- DWORD dwSyncDeltaTime;
- DWORD cDistPoint;
- PCERT_ALT_NAME_INFO rgDistPoint;
- } CROSS_CERT_DIST_POINTS_INFO, *PCROSS_CERT_DIST_POINTS_INFO;
- #define CROSS_CERT_DIST_POINT_ERR_INDEX_MASK 0xFF
- #define CROSS_CERT_DIST_POINT_ERR_INDEX_SHIFT 24
- #define GET_CROSS_CERT_DIST_POINT_ERR_INDEX(X) \
- ((X >> CROSS_CERT_DIST_POINT_ERR_INDEX_SHIFT) & \
- CROSS_CERT_DIST_POINT_ERR_INDEX_MASK)
- //+-------------------------------------------------------------------------
- // X509_ENHANCED_KEY_USAGE
- // szOID_ENHANCED_KEY_USAGE
- //
- // pvStructInfo points to a CERT_ENHKEY_USAGE, CTL_USAGE.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_CERT_PAIR
- //
- // pvStructInfo points to the following CERT_PAIR.
- //--------------------------------------------------------------------------
- typedef struct _CERT_PAIR {
- CERT_BLOB Forward; // OPTIONAL, if Forward.cbData == 0, omitted
- CERT_BLOB Reverse; // OPTIONAL, if Reverse.cbData == 0, omitted
- } CERT_PAIR, *PCERT_PAIR;
- //+-------------------------------------------------------------------------
- // szOID_CRL_NUMBER
- //
- // pvStructInfo points to an int.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_DELTA_CRL_INDICATOR
- //
- // pvStructInfo points to an int.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_ISSUING_DIST_POINT
- // X509_ISSUING_DIST_POINT
- //
- // pvStructInfo points to the following CRL_ISSUING_DIST_POINT.
- //
- // For CRYPT_E_INVALID_IA5_STRING, the error location is returned in
- // *pcbEncoded by CryptEncodeObject(X509_ISSUING_DIST_POINT)
- //
- // Error location consists of:
- // ENTRY_INDEX - 8 bits << 16
- // VALUE_INDEX - 16 bits (unicode character index)
- //
- // See X509_ALTERNATE_NAME for ENTRY_INDEX and VALUE_INDEX error location
- // defines.
- //--------------------------------------------------------------------------
- typedef struct _CRL_ISSUING_DIST_POINT {
- CRL_DIST_POINT_NAME DistPointName; // OPTIONAL
- BOOL fOnlyContainsUserCerts;
- BOOL fOnlyContainsCACerts;
- CRYPT_BIT_BLOB OnlySomeReasonFlags; // OPTIONAL
- BOOL fIndirectCRL;
- } CRL_ISSUING_DIST_POINT, *PCRL_ISSUING_DIST_POINT;
- //+-------------------------------------------------------------------------
- // szOID_FRESHEST_CRL
- //
- // pvStructInfo points to CRL_DIST_POINTS_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NAME_CONSTRAINTS
- // X509_NAME_CONSTRAINTS
- //
- // pvStructInfo points to the following CERT_NAME_CONSTRAINTS_INFO
- //
- // For CRYPT_E_INVALID_IA5_STRING, the error location is returned in
- // *pcbEncoded by CryptEncodeObject(X509_NAME_CONSTRAINTS)
- //
- // Error location consists of:
- // EXCLUDED_SUBTREE_BIT - 1 bit << 31 (0 for permitted, 1 for excluded)
- // ENTRY_INDEX - 8 bits << 16
- // VALUE_INDEX - 16 bits (unicode character index)
- //
- // See X509_ALTERNATE_NAME for ENTRY_INDEX and VALUE_INDEX error location
- // defines.
- //--------------------------------------------------------------------------
- typedef struct _CERT_GENERAL_SUBTREE {
- CERT_ALT_NAME_ENTRY Base;
- DWORD dwMinimum;
- BOOL fMaximum;
- DWORD dwMaximum;
- } CERT_GENERAL_SUBTREE, *PCERT_GENERAL_SUBTREE;
- typedef struct _CERT_NAME_CONSTRAINTS_INFO {
- DWORD cPermittedSubtree;
- PCERT_GENERAL_SUBTREE rgPermittedSubtree;
- DWORD cExcludedSubtree;
- PCERT_GENERAL_SUBTREE rgExcludedSubtree;
- } CERT_NAME_CONSTRAINTS_INFO, *PCERT_NAME_CONSTRAINTS_INFO;
- #define CERT_EXCLUDED_SUBTREE_BIT 0x80000000L
- #define IS_CERT_EXCLUDED_SUBTREE(X) \
- (0 != (X & CERT_EXCLUDED_SUBTREE_BIT))
- //+-------------------------------------------------------------------------
- // szOID_NEXT_UPDATE_LOCATION
- //
- // pvStructInfo points to a CERT_ALT_NAME_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_REMOVE_CERTIFICATE
- //
- // pvStructInfo points to an int which can be set to one of the following
- // 0 - Add certificate
- // 1 - Remove certificate
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // PKCS_CTL
- // szOID_CTL
- //
- // pvStructInfo points to a CTL_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // PKCS_SORTED_CTL
- //
- // pvStructInfo points to a CTL_INFO.
- //
- // Same as for PKCS_CTL, except, the CTL entries are sorted. The following
- // extension containing the sort information is inserted as the first
- // extension in the encoded CTL.
- //
- // Only supported for Encoding. CRYPT_ENCODE_ALLOC_FLAG flag must be
- // set.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Sorted CTL TrustedSubjects extension
- //
- // Array of little endian DWORDs:
- // [0] - Flags
- // [1] - Count of HashBucket entry offsets
- // [2] - Maximum HashBucket entry collision count
- // [3 ..] (Count + 1) HashBucket entry offsets
- //
- // When this extension is present in the CTL,
- // the ASN.1 encoded sequence of TrustedSubjects are HashBucket ordered.
- //
- // The entry offsets point to the start of the first encoded TrustedSubject
- // sequence for the HashBucket. The encoded TrustedSubjects for a HashBucket
- // continue until the encoded offset of the next HashBucket. A HashBucket has
- // no entries if HashBucket[N] == HashBucket[N + 1].
- //
- // The HashBucket offsets are from the start of the ASN.1 encoded CTL_INFO.
- //--------------------------------------------------------------------------
- #define SORTED_CTL_EXT_FLAGS_OFFSET (0*4)
- #define SORTED_CTL_EXT_COUNT_OFFSET (1*4)
- #define SORTED_CTL_EXT_MAX_COLLISION_OFFSET (2*4)
- #define SORTED_CTL_EXT_HASH_BUCKET_OFFSET (3*4)
- // If the SubjectIdentifiers are a MD5 or SHA1 hash, the following flag is
- // set. When set, the first 4 bytes of the SubjectIdentifier are used as
- // the dwhash. Otherwise, the SubjectIdentifier bytes are hashed into dwHash.
- // In either case the HashBucket index = dwHash % cHashBucket.
- #define SORTED_CTL_EXT_HASHED_SUBJECT_IDENTIFIER_FLAG 0x1
- //+-------------------------------------------------------------------------
- // X509_MULTI_BYTE_UINT
- //
- // pvStructInfo points to a CRYPT_UINT_BLOB. Before encoding, inserts a
- // leading 0x00. After decoding, removes a leading 0x00.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_DSS_PUBLICKEY
- //
- // pvStructInfo points to a CRYPT_UINT_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_DSS_PARAMETERS
- //
- // pvStructInfo points to following CERT_DSS_PARAMETERS data structure.
- //--------------------------------------------------------------------------
- typedef struct _CERT_DSS_PARAMETERS {
- CRYPT_UINT_BLOB p;
- CRYPT_UINT_BLOB q;
- CRYPT_UINT_BLOB g;
- } CERT_DSS_PARAMETERS, *PCERT_DSS_PARAMETERS;
- //+-------------------------------------------------------------------------
- // X509_DSS_SIGNATURE
- //
- // pvStructInfo is a BYTE rgbSignature[CERT_DSS_SIGNATURE_LEN]. The
- // bytes are ordered as output by the DSS CSP's CryptSignHash().
- //--------------------------------------------------------------------------
- #define CERT_DSS_R_LEN 20
- #define CERT_DSS_S_LEN 20
- #define CERT_DSS_SIGNATURE_LEN (CERT_DSS_R_LEN + CERT_DSS_S_LEN)
- // Sequence of 2 unsigned integers (the extra +1 is for a potential leading
- // 0x00 to make the integer unsigned)
- #define CERT_MAX_ASN_ENCODED_DSS_SIGNATURE_LEN (2 + 2*(2 + 20 +1))
- //+-------------------------------------------------------------------------
- // X509_DH_PUBLICKEY
- //
- // pvStructInfo points to a CRYPT_UINT_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // X509_DH_PARAMETERS
- //
- // pvStructInfo points to following CERT_DH_PARAMETERS data structure.
- //--------------------------------------------------------------------------
- typedef struct _CERT_DH_PARAMETERS {
- CRYPT_UINT_BLOB p;
- CRYPT_UINT_BLOB g;
- } CERT_DH_PARAMETERS, *PCERT_DH_PARAMETERS;
- //+-------------------------------------------------------------------------
- // X942_DH_PARAMETERS
- //
- // pvStructInfo points to following CERT_X942_DH_PARAMETERS data structure.
- //
- // If q.cbData == 0, then, the following fields are zero'ed.
- //--------------------------------------------------------------------------
- typedef struct _CERT_X942_DH_VALIDATION_PARAMS {
- CRYPT_BIT_BLOB seed;
- DWORD pgenCounter;
- } CERT_X942_DH_VALIDATION_PARAMS, *PCERT_X942_DH_VALIDATION_PARAMS;
- typedef struct _CERT_X942_DH_PARAMETERS {
- CRYPT_UINT_BLOB p; // odd prime, p = jq + 1
- CRYPT_UINT_BLOB g; // generator, g
- CRYPT_UINT_BLOB q; // factor of p - 1, OPTIONAL
- CRYPT_UINT_BLOB j; // subgroup factor, OPTIONAL
- PCERT_X942_DH_VALIDATION_PARAMS pValidationParams; // OPTIONAL
- } CERT_X942_DH_PARAMETERS, *PCERT_X942_DH_PARAMETERS;
- //+-------------------------------------------------------------------------
- // X942_OTHER_INFO
- //
- // pvStructInfo points to following CRYPT_X942_OTHER_INFO data structure.
- //
- // rgbCounter and rgbKeyLength are in Little Endian order.
- //--------------------------------------------------------------------------
- #define CRYPT_X942_COUNTER_BYTE_LENGTH 4
- #define CRYPT_X942_KEY_LENGTH_BYTE_LENGTH 4
- #define CRYPT_X942_PUB_INFO_BYTE_LENGTH (512/8)
- typedef struct _CRYPT_X942_OTHER_INFO {
- LPSTR pszContentEncryptionObjId;
- BYTE rgbCounter[CRYPT_X942_COUNTER_BYTE_LENGTH];
- BYTE rgbKeyLength[CRYPT_X942_KEY_LENGTH_BYTE_LENGTH];
- CRYPT_DATA_BLOB PubInfo; // OPTIONAL
- } CRYPT_X942_OTHER_INFO, *PCRYPT_X942_OTHER_INFO;
- //+-------------------------------------------------------------------------
- // PKCS_RC2_CBC_PARAMETERS
- // szOID_RSA_RC2CBC
- //
- // pvStructInfo points to following CRYPT_RC2_CBC_PARAMETERS data structure.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_RC2_CBC_PARAMETERS {
- DWORD dwVersion;
- BOOL fIV; // set if has following IV
- BYTE rgbIV[8];
- } CRYPT_RC2_CBC_PARAMETERS, *PCRYPT_RC2_CBC_PARAMETERS;
- #define CRYPT_RC2_40BIT_VERSION 160
- #define CRYPT_RC2_56BIT_VERSION 52
- #define CRYPT_RC2_64BIT_VERSION 120
- #define CRYPT_RC2_128BIT_VERSION 58
- //+-------------------------------------------------------------------------
- // PKCS_SMIME_CAPABILITIES
- // szOID_RSA_SMIMECapabilities
- //
- // pvStructInfo points to following CRYPT_SMIME_CAPABILITIES data structure.
- //
- // Note, for CryptEncodeObject(X509_ASN_ENCODING), Parameters.cbData == 0
- // causes the encoded parameters to be omitted and not encoded as a NULL
- // (05 00) as is done when encoding a CRYPT_ALGORITHM_IDENTIFIER. This
- // is per the SMIME specification for encoding capabilities.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_SMIME_CAPABILITY {
- LPSTR pszObjId;
- CRYPT_OBJID_BLOB Parameters;
- } CRYPT_SMIME_CAPABILITY, *PCRYPT_SMIME_CAPABILITY;
- typedef struct _CRYPT_SMIME_CAPABILITIES {
- DWORD cCapability;
- PCRYPT_SMIME_CAPABILITY rgCapability;
- } CRYPT_SMIME_CAPABILITIES, *PCRYPT_SMIME_CAPABILITIES;
- //+-------------------------------------------------------------------------
- // PKCS7_SIGNER_INFO
- //
- // pvStructInfo points to CMSG_SIGNER_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMS_SIGNER_INFO
- //
- // pvStructInfo points to CMSG_CMS_SIGNER_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Verisign Certificate Extension Object Identifiers
- //--------------------------------------------------------------------------
- // Octet String containing Boolean
- #define szOID_VERISIGN_PRIVATE_6_9 "2.16.840.1.113733.1.6.9"
- // Octet String containing IA5 string: lower case 32 char hex string
- #define szOID_VERISIGN_ONSITE_JURISDICTION_HASH "2.16.840.1.113733.1.6.11"
- // Octet String containing Bit string
- #define szOID_VERISIGN_BITSTRING_6_13 "2.16.840.1.113733.1.6.13"
- // EKU
- #define szOID_VERISIGN_ISS_STRONG_CRYPTO "2.16.840.1.113733.1.8.1"
- //+-------------------------------------------------------------------------
- // Netscape Certificate Extension Object Identifiers
- //--------------------------------------------------------------------------
- #define szOID_NETSCAPE "2.16.840.1.113730"
- #define szOID_NETSCAPE_CERT_EXTENSION "2.16.840.1.113730.1"
- #define szOID_NETSCAPE_CERT_TYPE "2.16.840.1.113730.1.1"
- #define szOID_NETSCAPE_BASE_URL "2.16.840.1.113730.1.2"
- #define szOID_NETSCAPE_REVOCATION_URL "2.16.840.1.113730.1.3"
- #define szOID_NETSCAPE_CA_REVOCATION_URL "2.16.840.1.113730.1.4"
- #define szOID_NETSCAPE_CERT_RENEWAL_URL "2.16.840.1.113730.1.7"
- #define szOID_NETSCAPE_CA_POLICY_URL "2.16.840.1.113730.1.8"
- #define szOID_NETSCAPE_SSL_SERVER_NAME "2.16.840.1.113730.1.12"
- #define szOID_NETSCAPE_COMMENT "2.16.840.1.113730.1.13"
- //+-------------------------------------------------------------------------
- // Netscape Certificate Data Type Object Identifiers
- //--------------------------------------------------------------------------
- #define szOID_NETSCAPE_DATA_TYPE "2.16.840.1.113730.2"
- #define szOID_NETSCAPE_CERT_SEQUENCE "2.16.840.1.113730.2.5"
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_CERT_TYPE extension
- //
- // Its value is a bit string. CryptDecodeObject/CryptEncodeObject using
- // X509_BITS or X509_BITS_WITHOUT_TRAILING_ZEROES.
- //
- // The following bits are defined:
- //--------------------------------------------------------------------------
- #define NETSCAPE_SSL_CLIENT_AUTH_CERT_TYPE 0x80
- #define NETSCAPE_SSL_SERVER_AUTH_CERT_TYPE 0x40
- #define NETSCAPE_SMIME_CERT_TYPE 0x20
- #define NETSCAPE_SIGN_CERT_TYPE 0x10
- #define NETSCAPE_SSL_CA_CERT_TYPE 0x04
- #define NETSCAPE_SMIME_CA_CERT_TYPE 0x02
- #define NETSCAPE_SIGN_CA_CERT_TYPE 0x01
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_BASE_URL extension
- //
- // Its value is an IA5_STRING. CryptDecodeObject/CryptEncodeObject using
- // X509_ANY_STRING or X509_UNICODE_ANY_STRING, where,
- // dwValueType = CERT_RDN_IA5_STRING.
- //
- // When present this string is added to the beginning of all relative URLs
- // in the certificate. This extension can be considered an optimization
- // to reduce the size of the URL extensions.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_REVOCATION_URL extension
- //
- // Its value is an IA5_STRING. CryptDecodeObject/CryptEncodeObject using
- // X509_ANY_STRING or X509_UNICODE_ANY_STRING, where,
- // dwValueType = CERT_RDN_IA5_STRING.
- //
- // It is a relative or absolute URL that can be used to check the
- // revocation status of a certificate. The revocation check will be
- // performed as an HTTP GET method using a url that is the concatenation of
- // revocation-url and certificate-serial-number.
- // Where the certificate-serial-number is encoded as a string of
- // ascii hexadecimal digits. For example, if the netscape-base-url is
- // https://www.certs-r-us.com/, the netscape-revocation-url is
- // cgi-bin/check-rev.cgi?, and the certificate serial number is 173420,
- // the resulting URL would be:
- // https://www.certs-r-us.com/cgi-bin/check-rev.cgi?02a56c
- //
- // The server should return a document with a Content-Type of
- // application/x-netscape-revocation. The document should contain
- // a single ascii digit, '1' if the certificate is not curently valid,
- // and '0' if it is curently valid.
- //
- // Note: for all of the URLs that include the certificate serial number,
- // the serial number will be encoded as a string which consists of an even
- // number of hexadecimal digits. If the number of significant digits is odd,
- // the string will have a single leading zero to ensure an even number of
- // digits is generated.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_CA_REVOCATION_URL extension
- //
- // Its value is an IA5_STRING. CryptDecodeObject/CryptEncodeObject using
- // X509_ANY_STRING or X509_UNICODE_ANY_STRING, where,
- // dwValueType = CERT_RDN_IA5_STRING.
- //
- // It is a relative or absolute URL that can be used to check the
- // revocation status of any certificates that are signed by the CA that
- // this certificate belongs to. This extension is only valid in CA
- // certificates. The use of this extension is the same as the above
- // szOID_NETSCAPE_REVOCATION_URL extension.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_CERT_RENEWAL_URL extension
- //
- // Its value is an IA5_STRING. CryptDecodeObject/CryptEncodeObject using
- // X509_ANY_STRING or X509_UNICODE_ANY_STRING, where,
- // dwValueType = CERT_RDN_IA5_STRING.
- //
- // It is a relative or absolute URL that points to a certificate renewal
- // form. The renewal form will be accessed with an HTTP GET method using a
- // url that is the concatenation of renewal-url and
- // certificate-serial-number. Where the certificate-serial-number is
- // encoded as a string of ascii hexadecimal digits. For example, if the
- // netscape-base-url is https://www.certs-r-us.com/, the
- // netscape-cert-renewal-url is cgi-bin/check-renew.cgi?, and the
- // certificate serial number is 173420, the resulting URL would be:
- // https://www.certs-r-us.com/cgi-bin/check-renew.cgi?02a56c
- // The document returned should be an HTML form that will allow the user
- // to request a renewal of their certificate.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_CA_POLICY_URL extension
- //
- // Its value is an IA5_STRING. CryptDecodeObject/CryptEncodeObject using
- // X509_ANY_STRING or X509_UNICODE_ANY_STRING, where,
- // dwValueType = CERT_RDN_IA5_STRING.
- //
- // It is a relative or absolute URL that points to a web page that
- // describes the policies under which the certificate was issued.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_SSL_SERVER_NAME extension
- //
- // Its value is an IA5_STRING. CryptDecodeObject/CryptEncodeObject using
- // X509_ANY_STRING or X509_UNICODE_ANY_STRING, where,
- // dwValueType = CERT_RDN_IA5_STRING.
- //
- // It is a "shell expression" that can be used to match the hostname of the
- // SSL server that is using this certificate. It is recommended that if
- // the server's hostname does not match this pattern the user be notified
- // and given the option to terminate the SSL connection. If this extension
- // is not present then the CommonName in the certificate subject's
- // distinguished name is used for the same purpose.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_COMMENT extension
- //
- // Its value is an IA5_STRING. CryptDecodeObject/CryptEncodeObject using
- // X509_ANY_STRING or X509_UNICODE_ANY_STRING, where,
- // dwValueType = CERT_RDN_IA5_STRING.
- //
- // It is a comment that may be displayed to the user when the certificate
- // is viewed.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // szOID_NETSCAPE_CERT_SEQUENCE
- //
- // Its value is a PKCS#7 ContentInfo structure wrapping a sequence of
- // certificates. The value of the contentType field is
- // szOID_NETSCAPE_CERT_SEQUENCE, while the content field is the following
- // structure:
- // CertificateSequence ::= SEQUENCE OF Certificate.
- //
- // CryptDecodeObject/CryptEncodeObject using
- // PKCS_CONTENT_INFO_SEQUENCE_OF_ANY, where,
- // pszObjId = szOID_NETSCAPE_CERT_SEQUENCE and the CRYPT_DER_BLOBs point
- // to encoded X509 certificates.
- //--------------------------------------------------------------------------
- //+=========================================================================
- // Certificate Management Messages over CMS (CMC) Data Structures
- //==========================================================================
- // Content Type (request)
- #define szOID_CT_PKI_DATA "1.3.6.1.5.5.7.12.2"
- // Content Type (response)
- #define szOID_CT_PKI_RESPONSE "1.3.6.1.5.5.7.12.3"
- // Signature value that only contains the hash octets. The parameters for
- // this algorithm must be present and must be encoded as NULL.
- #define szOID_PKIX_NO_SIGNATURE "1.3.6.1.5.5.7.6.2"
- #define szOID_CMC "1.3.6.1.5.5.7.7"
- #define szOID_CMC_STATUS_INFO "1.3.6.1.5.5.7.7.1"
- #define szOID_CMC_IDENTIFICATION "1.3.6.1.5.5.7.7.2"
- #define szOID_CMC_IDENTITY_PROOF "1.3.6.1.5.5.7.7.3"
- #define szOID_CMC_DATA_RETURN "1.3.6.1.5.5.7.7.4"
- // Transaction Id (integer)
- #define szOID_CMC_TRANSACTION_ID "1.3.6.1.5.5.7.7.5"
- // Sender Nonce (octet string)
- #define szOID_CMC_SENDER_NONCE "1.3.6.1.5.5.7.7.6"
- // Recipient Nonce (octet string)
- #define szOID_CMC_RECIPIENT_NONCE "1.3.6.1.5.5.7.7.7"
- #define szOID_CMC_ADD_EXTENSIONS "1.3.6.1.5.5.7.7.8"
- #define szOID_CMC_ENCRYPTED_POP "1.3.6.1.5.5.7.7.9"
- #define szOID_CMC_DECRYPTED_POP "1.3.6.1.5.5.7.7.10"
- #define szOID_CMC_LRA_POP_WITNESS "1.3.6.1.5.5.7.7.11"
- // Issuer Name + Serial
- #define szOID_CMC_GET_CERT "1.3.6.1.5.5.7.7.15"
- // Issuer Name [+ CRL Name] + Time [+ Reasons]
- #define szOID_CMC_GET_CRL "1.3.6.1.5.5.7.7.16"
- // Issuer Name + Serial [+ Reason] [+ Effective Time] [+ Secret] [+ Comment]
- #define szOID_CMC_REVOKE_REQUEST "1.3.6.1.5.5.7.7.17"
- // (octet string) URL-style parameter list (IA5?)
- #define szOID_CMC_REG_INFO "1.3.6.1.5.5.7.7.18"
- #define szOID_CMC_RESPONSE_INFO "1.3.6.1.5.5.7.7.19"
- // (octet string)
- #define szOID_CMC_QUERY_PENDING "1.3.6.1.5.5.7.7.21"
- #define szOID_CMC_ID_POP_LINK_RANDOM "1.3.6.1.5.5.7.7.22"
- #define szOID_CMC_ID_POP_LINK_WITNESS "1.3.6.1.5.5.7.7.23"
- // optional Name + Integer
- #define szOID_CMC_ID_CONFIRM_CERT_ACCEPTANCE "1.3.6.1.5.5.7.7.24"
- #define szOID_CMC_ADD_ATTRIBUTES "1.3.6.1.4.1.311.10.10.1"
- //+-------------------------------------------------------------------------
- // CMC_DATA
- // CMC_RESPONSE
- //
- // Certificate Management Messages over CMS (CMC) PKIData and Response
- // messages.
- //
- // For CMC_DATA, pvStructInfo points to a CMC_DATA_INFO.
- // CMC_DATA_INFO contains optional arrays of tagged attributes, requests,
- // content info and/or arbitrary other messages.
- //
- // For CMC_RESPONSE, pvStructInfo points to a CMC_RESPONSE_INFO.
- // CMC_RESPONSE_INFO is the same as CMC_DATA_INFO without the tagged
- // requests.
- //--------------------------------------------------------------------------
- typedef struct _CMC_TAGGED_ATTRIBUTE {
- DWORD dwBodyPartID;
- CRYPT_ATTRIBUTE Attribute;
- } CMC_TAGGED_ATTRIBUTE, *PCMC_TAGGED_ATTRIBUTE;
- typedef struct _CMC_TAGGED_CERT_REQUEST {
- DWORD dwBodyPartID;
- CRYPT_DER_BLOB SignedCertRequest;
- } CMC_TAGGED_CERT_REQUEST, *PCMC_TAGGED_CERT_REQUEST;
- typedef struct _CMC_TAGGED_REQUEST {
- DWORD dwTaggedRequestChoice;
- union {
- // CMC_TAGGED_CERT_REQUEST_CHOICE
- PCMC_TAGGED_CERT_REQUEST pTaggedCertRequest;
- };
- } CMC_TAGGED_REQUEST, *PCMC_TAGGED_REQUEST;
- #define CMC_TAGGED_CERT_REQUEST_CHOICE 1
- typedef struct _CMC_TAGGED_CONTENT_INFO {
- DWORD dwBodyPartID;
- CRYPT_DER_BLOB EncodedContentInfo;
- } CMC_TAGGED_CONTENT_INFO, *PCMC_TAGGED_CONTENT_INFO;
- typedef struct _CMC_TAGGED_OTHER_MSG {
- DWORD dwBodyPartID;
- LPSTR pszObjId;
- CRYPT_OBJID_BLOB Value;
- } CMC_TAGGED_OTHER_MSG, *PCMC_TAGGED_OTHER_MSG;
- // All the tagged arrays are optional
- typedef struct _CMC_DATA_INFO {
- DWORD cTaggedAttribute;
- PCMC_TAGGED_ATTRIBUTE rgTaggedAttribute;
- DWORD cTaggedRequest;
- PCMC_TAGGED_REQUEST rgTaggedRequest;
- DWORD cTaggedContentInfo;
- PCMC_TAGGED_CONTENT_INFO rgTaggedContentInfo;
- DWORD cTaggedOtherMsg;
- PCMC_TAGGED_OTHER_MSG rgTaggedOtherMsg;
- } CMC_DATA_INFO, *PCMC_DATA_INFO;
- // All the tagged arrays are optional
- typedef struct _CMC_RESPONSE_INFO {
- DWORD cTaggedAttribute;
- PCMC_TAGGED_ATTRIBUTE rgTaggedAttribute;
- DWORD cTaggedContentInfo;
- PCMC_TAGGED_CONTENT_INFO rgTaggedContentInfo;
- DWORD cTaggedOtherMsg;
- PCMC_TAGGED_OTHER_MSG rgTaggedOtherMsg;
- } CMC_RESPONSE_INFO, *PCMC_RESPONSE_INFO;
- //+-------------------------------------------------------------------------
- // CMC_STATUS
- //
- // Certificate Management Messages over CMS (CMC) Status.
- //
- // pvStructInfo points to a CMC_STATUS_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CMC_PEND_INFO {
- CRYPT_DATA_BLOB PendToken;
- FILETIME PendTime;
- } CMC_PEND_INFO, *PCMC_PEND_INFO;
- typedef struct _CMC_STATUS_INFO {
- DWORD dwStatus;
- DWORD cBodyList;
- DWORD *rgdwBodyList;
- LPWSTR pwszStatusString; // OPTIONAL
- DWORD dwOtherInfoChoice;
- union {
- // CMC_OTHER_INFO_NO_CHOICE
- // none
- // CMC_OTHER_INFO_FAIL_CHOICE
- DWORD dwFailInfo;
- // CMC_OTHER_INFO_PEND_CHOICE
- PCMC_PEND_INFO pPendInfo;
- };
- } CMC_STATUS_INFO, *PCMC_STATUS_INFO;
- #define CMC_OTHER_INFO_NO_CHOICE 0
- #define CMC_OTHER_INFO_FAIL_CHOICE 1
- #define CMC_OTHER_INFO_PEND_CHOICE 2
- //
- // dwStatus values
- //
- // Request was granted
- #define CMC_STATUS_SUCCESS 0
- // Request failed, more information elsewhere in the message
- #define CMC_STATUS_FAILED 2
- // The request body part has not yet been processed. Requester is responsible
- // to poll back. May only be returned for certificate request operations.
- #define CMC_STATUS_PENDING 3
- // The requested operation is not supported
- #define CMC_STATUS_NO_SUPPORT 4
- // Confirmation using the idConfirmCertAcceptance control is required
- // before use of certificate
- #define CMC_STATUS_CONFIRM_REQUIRED 5
- //
- // dwFailInfo values
- //
- // Unrecognized or unsupported algorithm
- #define CMC_FAIL_BAD_ALG 0
- // Integrity check failed
- #define CMC_FAIL_BAD_MESSAGE_CHECK 1
- // Transaction not permitted or supported
- #define CMC_FAIL_BAD_REQUEST 2
- // Message time field was not sufficiently close to the system time
- #define CMC_FAIL_BAD_TIME 3
- // No certificate could be identified matching the provided criteria
- #define CMC_FAIL_BAD_CERT_ID 4
- // A requested X.509 extension is not supported by the recipient CA.
- #define CMC_FAIL_UNSUPORTED_EXT 5
- // Private key material must be supplied
- #define CMC_FAIL_MUST_ARCHIVE_KEYS 6
- // Identification Attribute failed to verify
- #define CMC_FAIL_BAD_IDENTITY 7
- // Server requires a POP proof before issuing certificate
- #define CMC_FAIL_POP_REQUIRED 8
- // POP processing failed
- #define CMC_FAIL_POP_FAILED 9
- // Server policy does not allow key re-use
- #define CMC_FAIL_NO_KEY_REUSE 10
- #define CMC_FAIL_INTERNAL_CA_ERROR 11
- #define CMC_FAIL_TRY_LATER 12
- //+-------------------------------------------------------------------------
- // CMC_ADD_EXTENSIONS
- //
- // Certificate Management Messages over CMS (CMC) Add Extensions control
- // attribute.
- //
- // pvStructInfo points to a CMC_ADD_EXTENSIONS_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CMC_ADD_EXTENSIONS_INFO {
- DWORD dwCmcDataReference;
- DWORD cCertReference;
- DWORD *rgdwCertReference;
- DWORD cExtension;
- PCERT_EXTENSION rgExtension;
- } CMC_ADD_EXTENSIONS_INFO, *PCMC_ADD_EXTENSIONS_INFO;
- //+-------------------------------------------------------------------------
- // CMC_ADD_ATTRIBUTES
- //
- // Certificate Management Messages over CMS (CMC) Add Attributes control
- // attribute.
- //
- // pvStructInfo points to a CMC_ADD_ATTRIBUTES_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CMC_ADD_ATTRIBUTES_INFO {
- DWORD dwCmcDataReference;
- DWORD cCertReference;
- DWORD *rgdwCertReference;
- DWORD cAttribute;
- PCRYPT_ATTRIBUTE rgAttribute;
- } CMC_ADD_ATTRIBUTES_INFO, *PCMC_ADD_ATTRIBUTES_INFO;
- //+-------------------------------------------------------------------------
- // X509_CERTIFICATE_TEMPLATE
- // szOID_CERTIFICATE_TEMPLATE
- //
- // pvStructInfo points to following CERT_TEMPLATE_EXT data structure.
- //
- //--------------------------------------------------------------------------
- typedef struct _CERT_TEMPLATE_EXT {
- LPSTR pszObjId;
- DWORD dwMajorVersion;
- BOOL fMinorVersion; // TRUE for a minor version
- DWORD dwMinorVersion;
- } CERT_TEMPLATE_EXT, *PCERT_TEMPLATE_EXT;
- //+=========================================================================
- // Object IDentifier (OID) Installable Functions: Data Structures and APIs
- //==========================================================================
- typedef void *HCRYPTOIDFUNCSET;
- typedef void *HCRYPTOIDFUNCADDR;
- // Predefined OID Function Names
- #define CRYPT_OID_ENCODE_OBJECT_FUNC "CryptDllEncodeObject"
- #define CRYPT_OID_DECODE_OBJECT_FUNC "CryptDllDecodeObject"
- #define CRYPT_OID_ENCODE_OBJECT_EX_FUNC "CryptDllEncodeObjectEx"
- #define CRYPT_OID_DECODE_OBJECT_EX_FUNC "CryptDllDecodeObjectEx"
- #define CRYPT_OID_CREATE_COM_OBJECT_FUNC "CryptDllCreateCOMObject"
- #define CRYPT_OID_VERIFY_REVOCATION_FUNC "CertDllVerifyRevocation"
- #define CRYPT_OID_VERIFY_CTL_USAGE_FUNC "CertDllVerifyCTLUsage"
- #define CRYPT_OID_FORMAT_OBJECT_FUNC "CryptDllFormatObject"
- #define CRYPT_OID_FIND_OID_INFO_FUNC "CryptDllFindOIDInfo"
- #define CRYPT_OID_FIND_LOCALIZED_NAME_FUNC "CryptDllFindLocalizedName"
- // CryptDllEncodeObject has same function signature as CryptEncodeObject.
- // CryptDllDecodeObject has same function signature as CryptDecodeObject.
- // CryptDllEncodeObjectEx has same function signature as CryptEncodeObjectEx.
- // The Ex version MUST support the CRYPT_ENCODE_ALLOC_FLAG option.
- //
- // If an Ex function isn't installed or registered, then, attempts to find
- // a non-EX version. If the ALLOC flag is set, then, CryptEncodeObjectEx,
- // does the allocation and calls the non-EX version twice.
- // CryptDllDecodeObjectEx has same function signature as CryptDecodeObjectEx.
- // The Ex version MUST support the CRYPT_DECODE_ALLOC_FLAG option.
- //
- // If an Ex function isn't installed or registered, then, attempts to find
- // a non-EX version. If the ALLOC flag is set, then, CryptDecodeObjectEx,
- // does the allocation and calls the non-EX version twice.
- // CryptDllCreateCOMObject has the following signature:
- // BOOL WINAPI CryptDllCreateCOMObject(
- // IN DWORD dwEncodingType,
- // IN LPCSTR pszOID,
- // IN PCRYPT_DATA_BLOB pEncodedContent,
- // IN DWORD dwFlags,
- // IN REFIID riid,
- // OUT void **ppvObj);
- // CertDllVerifyRevocation has the same signature as CertVerifyRevocation
- // (See CertVerifyRevocation for details on when called)
- // CertDllVerifyCTLUsage has the same signature as CertVerifyCTLUsage
- // CryptDllFindOIDInfo currently is only used to store values used by
- // CryptFindOIDInfo. See CryptFindOIDInfo() for more details.
- // CryptDllFindLocalizedName is only used to store localized string
- // values used by CryptFindLocalizedName. See CryptFindLocalizedName() for
- // more details.
- // Example of a complete OID Function Registry Name:
- // HKEY_LOCAL_MACHINE\Software\Microsoft\Cryptography\OID
- // Encoding Type 1\CryptDllEncodeObject\1.2.3
- //
- // The key's L"Dll" value contains the name of the Dll.
- // The key's L"FuncName" value overrides the default function name
- #define CRYPT_OID_REGPATH "Software\\Microsoft\\Cryptography\\OID"
- #define CRYPT_OID_REG_ENCODING_TYPE_PREFIX "EncodingType "
- #define CRYPT_OID_REG_DLL_VALUE_NAME L"Dll"
- #define CRYPT_OID_REG_FUNC_NAME_VALUE_NAME L"FuncName"
- #define CRYPT_OID_REG_FUNC_NAME_VALUE_NAME_A "FuncName"
- // CRYPT_INSTALL_OID_FUNC_BEFORE_FLAG can be set in the key's L"CryptFlags"
- // value to register the functions before the installed functions.
- //
- // CryptSetOIDFunctionValue must be called to set this value. L"CryptFlags"
- // must be set using a dwValueType of REG_DWORD.
- #define CRYPT_OID_REG_FLAGS_VALUE_NAME L"CryptFlags"
- // OID used for Default OID functions
- #define CRYPT_DEFAULT_OID "DEFAULT"
- typedef struct _CRYPT_OID_FUNC_ENTRY {
- LPCSTR pszOID;
- void *pvFuncAddr;
- } CRYPT_OID_FUNC_ENTRY, *PCRYPT_OID_FUNC_ENTRY;
- #define CRYPT_INSTALL_OID_FUNC_BEFORE_FLAG 1
- //+-------------------------------------------------------------------------
- // Install a set of callable OID function addresses.
- //
- // By default the functions are installed at end of the list.
- // Set CRYPT_INSTALL_OID_FUNC_BEFORE_FLAG to install at beginning of list.
- //
- // hModule should be updated with the hModule passed to DllMain to prevent
- // the Dll containing the function addresses from being unloaded by
- // CryptGetOIDFuncAddress/CryptFreeOIDFunctionAddress. This would be the
- // case when the Dll has also regsvr32'ed OID functions via
- // CryptRegisterOIDFunction.
- //
- // DEFAULT functions are installed by setting rgFuncEntry[].pszOID =
- // CRYPT_DEFAULT_OID.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptInstallOIDFunctionAddress(
- IN HMODULE hModule, // hModule passed to DllMain
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN DWORD cFuncEntry,
- IN const CRYPT_OID_FUNC_ENTRY rgFuncEntry[],
- IN DWORD dwFlags
- );
- //+-------------------------------------------------------------------------
- // Initialize and return handle to the OID function set identified by its
- // function name.
- //
- // If the set already exists, a handle to the existing set is returned.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCRYPTOIDFUNCSET
- WINAPI
- CryptInitOIDFunctionSet(
- IN LPCSTR pszFuncName,
- IN DWORD dwFlags
- );
- //+-------------------------------------------------------------------------
- // Search the list of installed functions for an encoding type and OID match.
- // If not found, search the registry.
- //
- // For success, returns TRUE with *ppvFuncAddr updated with the function's
- // address and *phFuncAddr updated with the function address's handle.
- // The function's handle is AddRef'ed. CryptFreeOIDFunctionAddress needs to
- // be called to release it.
- //
- // For a registry match, the Dll containing the function is loaded.
- //
- // By default, both the registered and installed function lists are searched.
- // Set CRYPT_GET_INSTALLED_OID_FUNC_FLAG to only search the installed list
- // of functions. This flag would be set by a registered function to get
- // the address of a pre-installed function it was replacing. For example,
- // the registered function might handle a new special case and call the
- // pre-installed function to handle the remaining cases.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetOIDFunctionAddress(
- IN HCRYPTOIDFUNCSET hFuncSet,
- IN DWORD dwEncodingType,
- IN LPCSTR pszOID,
- IN DWORD dwFlags,
- OUT void **ppvFuncAddr,
- OUT HCRYPTOIDFUNCADDR *phFuncAddr
- );
- #define CRYPT_GET_INSTALLED_OID_FUNC_FLAG 0x1
- //+-------------------------------------------------------------------------
- // Get the list of registered default Dll entries for the specified
- // function set and encoding type.
- //
- // The returned list consists of none, one or more null terminated Dll file
- // names. The list is terminated with an empty (L"\0") Dll file name.
- // For example: L"first.dll" L"\0" L"second.dll" L"\0" L"\0"
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetDefaultOIDDllList(
- IN HCRYPTOIDFUNCSET hFuncSet,
- IN DWORD dwEncodingType,
- OUT LPWSTR pwszDllList,
- IN OUT DWORD *pcchDllList
- );
- //+-------------------------------------------------------------------------
- // Either: get the first or next installed DEFAULT function OR
- // load the Dll containing the DEFAULT function.
- //
- // If pwszDll is NULL, search the list of installed DEFAULT functions.
- // *phFuncAddr must be set to NULL to get the first installed function.
- // Successive installed functions are returned by setting *phFuncAddr
- // to the hFuncAddr returned by the previous call.
- //
- // If pwszDll is NULL, the input *phFuncAddr
- // is always CryptFreeOIDFunctionAddress'ed by this function, even for
- // an error.
- //
- // If pwszDll isn't NULL, then, attempts to load the Dll and the DEFAULT
- // function. *phFuncAddr is ignored upon entry and isn't
- // CryptFreeOIDFunctionAddress'ed.
- //
- // For success, returns TRUE with *ppvFuncAddr updated with the function's
- // address and *phFuncAddr updated with the function address's handle.
- // The function's handle is AddRef'ed. CryptFreeOIDFunctionAddress needs to
- // be called to release it or CryptGetDefaultOIDFunctionAddress can also
- // be called for a NULL pwszDll.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetDefaultOIDFunctionAddress(
- IN HCRYPTOIDFUNCSET hFuncSet,
- IN DWORD dwEncodingType,
- IN OPTIONAL LPCWSTR pwszDll,
- IN DWORD dwFlags,
- OUT void **ppvFuncAddr,
- IN OUT HCRYPTOIDFUNCADDR *phFuncAddr
- );
- //+-------------------------------------------------------------------------
- // Releases the handle AddRef'ed and returned by CryptGetOIDFunctionAddress
- // or CryptGetDefaultOIDFunctionAddress.
- //
- // If a Dll was loaded for the function its unloaded. However, before doing
- // the unload, the DllCanUnloadNow function exported by the loaded Dll is
- // called. It should return S_FALSE to inhibit the unload or S_TRUE to enable
- // the unload. If the Dll doesn't export DllCanUnloadNow, the Dll is unloaded.
- //
- // DllCanUnloadNow has the following signature:
- // STDAPI DllCanUnloadNow(void);
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptFreeOIDFunctionAddress(
- IN HCRYPTOIDFUNCADDR hFuncAddr,
- IN DWORD dwFlags
- );
- //+-------------------------------------------------------------------------
- // Register the Dll containing the function to be called for the specified
- // encoding type, function name and OID.
- //
- // pwszDll may contain environment-variable strings
- // which are ExpandEnvironmentStrings()'ed before loading the Dll.
- //
- // In addition to registering the DLL, you may override the
- // name of the function to be called. For example,
- // pszFuncName = "CryptDllEncodeObject",
- // pszOverrideFuncName = "MyEncodeXyz".
- // This allows a Dll to export multiple OID functions for the same
- // function name without needing to interpose its own OID dispatcher function.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptRegisterOIDFunction(
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN LPCSTR pszOID,
- IN OPTIONAL LPCWSTR pwszDll,
- IN OPTIONAL LPCSTR pszOverrideFuncName
- );
- //+-------------------------------------------------------------------------
- // Unregister the Dll containing the function to be called for the specified
- // encoding type, function name and OID.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptUnregisterOIDFunction(
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN LPCSTR pszOID
- );
- //+-------------------------------------------------------------------------
- // Register the Dll containing the default function to be called for the
- // specified encoding type and function name.
- //
- // Unlike CryptRegisterOIDFunction, you can't override the function name
- // needing to be exported by the Dll.
- //
- // The Dll is inserted before the entry specified by dwIndex.
- // dwIndex == 0, inserts at the beginning.
- // dwIndex == CRYPT_REGISTER_LAST_INDEX, appends at the end.
- //
- // pwszDll may contain environment-variable strings
- // which are ExpandEnvironmentStrings()'ed before loading the Dll.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptRegisterDefaultOIDFunction(
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN DWORD dwIndex,
- IN LPCWSTR pwszDll
- );
- #define CRYPT_REGISTER_FIRST_INDEX 0
- #define CRYPT_REGISTER_LAST_INDEX 0xFFFFFFFF
- //+-------------------------------------------------------------------------
- // Unregister the Dll containing the default function to be called for
- // the specified encoding type and function name.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptUnregisterDefaultOIDFunction(
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN LPCWSTR pwszDll
- );
- //+-------------------------------------------------------------------------
- // Set the value for the specified encoding type, function name, OID and
- // value name.
- //
- // See RegSetValueEx for the possible value types.
- //
- // String types are UNICODE.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSetOIDFunctionValue(
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN LPCSTR pszOID,
- IN LPCWSTR pwszValueName,
- IN DWORD dwValueType,
- IN const BYTE *pbValueData,
- IN DWORD cbValueData
- );
- //+-------------------------------------------------------------------------
- // Get the value for the specified encoding type, function name, OID and
- // value name.
- //
- // See RegEnumValue for the possible value types.
- //
- // String types are UNICODE.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetOIDFunctionValue(
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN LPCSTR pszOID,
- IN LPCWSTR pwszValueName,
- OUT DWORD *pdwValueType,
- OUT BYTE *pbValueData,
- IN OUT DWORD *pcbValueData
- );
- typedef BOOL (WINAPI *PFN_CRYPT_ENUM_OID_FUNC)(
- IN DWORD dwEncodingType,
- IN LPCSTR pszFuncName,
- IN LPCSTR pszOID,
- IN DWORD cValue,
- IN const DWORD rgdwValueType[],
- IN LPCWSTR const rgpwszValueName[],
- IN const BYTE * const rgpbValueData[],
- IN const DWORD rgcbValueData[],
- IN void *pvArg
- );
- //+-------------------------------------------------------------------------
- // Enumerate the OID functions identified by their encoding type,
- // function name and OID.
- //
- // pfnEnumOIDFunc is called for each registry key matching the input
- // parameters. Setting dwEncodingType to CRYPT_MATCH_ANY_ENCODING_TYPE matches
- // any. Setting pszFuncName or pszOID to NULL matches any.
- //
- // Set pszOID == CRYPT_DEFAULT_OID to restrict the enumeration to only the
- // DEFAULT functions
- //
- // String types are UNICODE.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptEnumOIDFunction(
- IN DWORD dwEncodingType,
- IN OPTIONAL LPCSTR pszFuncName,
- IN OPTIONAL LPCSTR pszOID,
- IN DWORD dwFlags,
- IN void *pvArg,
- IN PFN_CRYPT_ENUM_OID_FUNC pfnEnumOIDFunc
- );
- #define CRYPT_MATCH_ANY_ENCODING_TYPE 0xFFFFFFFF
- //+=========================================================================
- // Object IDentifier (OID) Information: Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // OID Information
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_OID_INFO {
- DWORD cbSize;
- LPCSTR pszOID;
- LPCWSTR pwszName;
- DWORD dwGroupId;
- union {
- DWORD dwValue;
- ALG_ID Algid;
- DWORD dwLength;
- };
- CRYPT_DATA_BLOB ExtraInfo;
- } CRYPT_OID_INFO, *PCRYPT_OID_INFO;
- typedef const CRYPT_OID_INFO CCRYPT_OID_INFO, *PCCRYPT_OID_INFO;
- //+-------------------------------------------------------------------------
- // OID Group IDs
- //--------------------------------------------------------------------------
- #define CRYPT_HASH_ALG_OID_GROUP_ID 1
- #define CRYPT_ENCRYPT_ALG_OID_GROUP_ID 2
- #define CRYPT_PUBKEY_ALG_OID_GROUP_ID 3
- #define CRYPT_SIGN_ALG_OID_GROUP_ID 4
- #define CRYPT_RDN_ATTR_OID_GROUP_ID 5
- #define CRYPT_EXT_OR_ATTR_OID_GROUP_ID 6
- #define CRYPT_ENHKEY_USAGE_OID_GROUP_ID 7
- #define CRYPT_POLICY_OID_GROUP_ID 8
- #define CRYPT_TEMPLATE_OID_GROUP_ID 9
- #define CRYPT_LAST_OID_GROUP_ID 9
- #define CRYPT_FIRST_ALG_OID_GROUP_ID CRYPT_HASH_ALG_OID_GROUP_ID
- #define CRYPT_LAST_ALG_OID_GROUP_ID CRYPT_SIGN_ALG_OID_GROUP_ID
- // The CRYPT_*_ALG_OID_GROUP_ID's have an Algid. The CRYPT_RDN_ATTR_OID_GROUP_ID
- // has a dwLength. The CRYPT_EXT_OR_ATTR_OID_GROUP_ID,
- // CRYPT_ENHKEY_USAGE_OID_GROUP_ID, CRYPT_POLICY_OID_GROUP_ID or
- // CRYPT_TEMPLATE_OID_GROUP_ID don't have a dwValue.
- //
- // CRYPT_PUBKEY_ALG_OID_GROUP_ID has the following optional ExtraInfo:
- // DWORD[0] - Flags. CRYPT_OID_INHIBIT_SIGNATURE_FORMAT_FLAG can be set to
- // inhibit the reformatting of the signature before
- // CryptVerifySignature is called or after CryptSignHash
- // is called. CRYPT_OID_USE_PUBKEY_PARA_FOR_PKCS7_FLAG can
- // be set to include the public key algorithm's parameters
- // in the PKCS7's digestEncryptionAlgorithm's parameters.
- // CRYPT_OID_NO_NULL_ALGORITHM_PARA_FLAG can be set to omit
- // NULL parameters when encoding.
- #define CRYPT_OID_INHIBIT_SIGNATURE_FORMAT_FLAG 0x1
- #define CRYPT_OID_USE_PUBKEY_PARA_FOR_PKCS7_FLAG 0x2
- #define CRYPT_OID_NO_NULL_ALGORITHM_PARA_FLAG 0x4
- // CRYPT_SIGN_ALG_OID_GROUP_ID has the following optional ExtraInfo:
- // DWORD[0] - Public Key Algid.
- // DWORD[1] - Flags. Same as above for CRYPT_PUBKEY_ALG_OID_GROUP_ID.
- // DWORD[2] - Optional CryptAcquireContext(CRYPT_VERIFYCONTEXT)'s dwProvType.
- // If omitted or 0, uses Public Key Algid to select
- // appropriate dwProvType for signature verification.
- // CRYPT_RDN_ATTR_OID_GROUP_ID has the following optional ExtraInfo:
- // Array of DWORDs:
- // [0 ..] - Null terminated list of acceptable RDN attribute
- // value types. An empty list implies CERT_RDN_PRINTABLE_STRING,
- // CERT_RDN_UNICODE_STRING, 0.
- //+-------------------------------------------------------------------------
- // Find OID information. Returns NULL if unable to find any information
- // for the specified key and group. Note, returns a pointer to a constant
- // data structure. The returned pointer MUST NOT be freed.
- //
- // dwKeyType's:
- // CRYPT_OID_INFO_OID_KEY, pvKey points to a szOID
- // CRYPT_OID_INFO_NAME_KEY, pvKey points to a wszName
- // CRYPT_OID_INFO_ALGID_KEY, pvKey points to an ALG_ID
- // CRYPT_OID_INFO_SIGN_KEY, pvKey points to an array of two ALG_ID's:
- // ALG_ID[0] - Hash Algid
- // ALG_ID[1] - PubKey Algid
- //
- // Setting dwGroupId to 0, searches all groups according to the dwKeyType.
- // Otherwise, only the dwGroupId is searched.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCRYPT_OID_INFO
- WINAPI
- CryptFindOIDInfo(
- IN DWORD dwKeyType,
- IN void *pvKey,
- IN DWORD dwGroupId
- );
- #define CRYPT_OID_INFO_OID_KEY 1
- #define CRYPT_OID_INFO_NAME_KEY 2
- #define CRYPT_OID_INFO_ALGID_KEY 3
- #define CRYPT_OID_INFO_SIGN_KEY 4
- //+-------------------------------------------------------------------------
- // Register OID information. The OID information specified in the
- // CCRYPT_OID_INFO structure is persisted to the registry.
- //
- // crypt32.dll contains information for the commonly known OIDs. This function
- // allows applications to augment crypt32.dll's OID information. During
- // CryptFindOIDInfo's first call, the registered OID information is installed.
- //
- // By default the registered OID information is installed after crypt32.dll's
- // OID entries. Set CRYPT_INSTALL_OID_INFO_BEFORE_FLAG to install before.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptRegisterOIDInfo(
- IN PCCRYPT_OID_INFO pInfo,
- IN DWORD dwFlags
- );
- #define CRYPT_INSTALL_OID_INFO_BEFORE_FLAG 1
- //+-------------------------------------------------------------------------
- // Unregister OID information. Only the pszOID and dwGroupId fields are
- // used to identify the OID information to be unregistered.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptUnregisterOIDInfo(
- IN PCCRYPT_OID_INFO pInfo
- );
- // If the callback returns FALSE, stops the enumeration.
- typedef BOOL (WINAPI *PFN_CRYPT_ENUM_OID_INFO)(
- IN PCCRYPT_OID_INFO pInfo,
- IN void *pvArg
- );
- //+-------------------------------------------------------------------------
- // Enumerate the OID information.
- //
- // pfnEnumOIDInfo is called for each OID information entry.
- //
- // Setting dwGroupId to 0 matches all groups. Otherwise, only enumerates
- // entries in the specified group.
- //
- // dwFlags currently isn't used and must be set to 0.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptEnumOIDInfo(
- IN DWORD dwGroupId,
- IN DWORD dwFlags,
- IN void *pvArg,
- IN PFN_CRYPT_ENUM_OID_INFO pfnEnumOIDInfo
- );
- //+-------------------------------------------------------------------------
- // Find the localized name for the specified name. For example, find the
- // localized name for the "Root" system store name. A case insensitive
- // string comparison is done.
- //
- // Returns NULL if unable to find the the specified name.
- //
- // Localized names for the predefined system stores ("Root", "My") and
- // predefined physical stores (".Default", ".LocalMachine") are pre-installed
- // as resource strings in crypt32.dll. CryptSetOIDFunctionValue can be called
- // as follows to register additional localized strings:
- // dwEncodingType = CRYPT_LOCALIZED_NAME_ENCODING_TYPE
- // pszFuncName = CRYPT_OID_FIND_LOCALIZED_NAME_FUNC
- // pszOID = CRYPT_LOCALIZED_NAME_OID
- // pwszValueName = Name to be localized, for example, L"ApplicationStore"
- // dwValueType = REG_SZ
- // pbValueData = pointer to the UNICODE localized string
- // cbValueData = (wcslen(UNICODE localized string) + 1) * sizeof(WCHAR)
- //
- // To unregister, set pbValueData to NULL and cbValueData to 0.
- //
- // The registered names are searched before the pre-installed names.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- LPCWSTR
- WINAPI
- CryptFindLocalizedName(
- IN LPCWSTR pwszCryptName
- );
- #define CRYPT_LOCALIZED_NAME_ENCODING_TYPE 0
- #define CRYPT_LOCALIZED_NAME_OID "LocalizedNames"
- //+=========================================================================
- // Low Level Cryptographic Message Data Structures and APIs
- //==========================================================================
- typedef void *HCRYPTMSG;
- #define szOID_PKCS_7_DATA "1.2.840.113549.1.7.1"
- #define szOID_PKCS_7_SIGNED "1.2.840.113549.1.7.2"
- #define szOID_PKCS_7_ENVELOPED "1.2.840.113549.1.7.3"
- #define szOID_PKCS_7_SIGNEDANDENVELOPED "1.2.840.113549.1.7.4"
- #define szOID_PKCS_7_DIGESTED "1.2.840.113549.1.7.5"
- #define szOID_PKCS_7_ENCRYPTED "1.2.840.113549.1.7.6"
- #define szOID_PKCS_9_CONTENT_TYPE "1.2.840.113549.1.9.3"
- #define szOID_PKCS_9_MESSAGE_DIGEST "1.2.840.113549.1.9.4"
- //+-------------------------------------------------------------------------
- // Message types
- //--------------------------------------------------------------------------
- #define CMSG_DATA 1
- #define CMSG_SIGNED 2
- #define CMSG_ENVELOPED 3
- #define CMSG_SIGNED_AND_ENVELOPED 4
- #define CMSG_HASHED 5
- #define CMSG_ENCRYPTED 6
- //+-------------------------------------------------------------------------
- // Message Type Bit Flags
- //--------------------------------------------------------------------------
- #define CMSG_ALL_FLAGS (~0UL)
- #define CMSG_DATA_FLAG (1 << CMSG_DATA)
- #define CMSG_SIGNED_FLAG (1 << CMSG_SIGNED)
- #define CMSG_ENVELOPED_FLAG (1 << CMSG_ENVELOPED)
- #define CMSG_SIGNED_AND_ENVELOPED_FLAG (1 << CMSG_SIGNED_AND_ENVELOPED)
- #define CMSG_HASHED_FLAG (1 << CMSG_HASHED)
- #define CMSG_ENCRYPTED_FLAG (1 << CMSG_ENCRYPTED)
- //+-------------------------------------------------------------------------
- // Certificate Issuer and SerialNumber
- //--------------------------------------------------------------------------
- typedef struct _CERT_ISSUER_SERIAL_NUMBER {
- CERT_NAME_BLOB Issuer;
- CRYPT_INTEGER_BLOB SerialNumber;
- } CERT_ISSUER_SERIAL_NUMBER, *PCERT_ISSUER_SERIAL_NUMBER;
- //+-------------------------------------------------------------------------
- // Certificate Identifier
- //--------------------------------------------------------------------------
- typedef struct _CERT_ID {
- DWORD dwIdChoice;
- union {
- // CERT_ID_ISSUER_SERIAL_NUMBER
- CERT_ISSUER_SERIAL_NUMBER IssuerSerialNumber;
- // CERT_ID_KEY_IDENTIFIER
- CRYPT_HASH_BLOB KeyId;
- // CERT_ID_SHA1_HASH
- CRYPT_HASH_BLOB HashId;
- };
- } CERT_ID, *PCERT_ID;
- #define CERT_ID_ISSUER_SERIAL_NUMBER 1
- #define CERT_ID_KEY_IDENTIFIER 2
- #define CERT_ID_SHA1_HASH 3
- //+-------------------------------------------------------------------------
- // The message encode information (pvMsgEncodeInfo) is message type dependent
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_DATA: pvMsgEncodeInfo = NULL
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_SIGNED
- //
- // The pCertInfo in the CMSG_SIGNER_ENCODE_INFO provides the Issuer, SerialNumber
- // and PublicKeyInfo.Algorithm. The PublicKeyInfo.Algorithm implicitly
- // specifies the HashEncryptionAlgorithm to be used.
- //
- // If the SignerId is present with a nonzero dwIdChoice its used instead
- // of the Issuer and SerialNumber in pCertInfo.
- //
- // CMS supports the KEY_IDENTIFIER and ISSUER_SERIAL_NUMBER CERT_IDs. PKCS #7
- // version 1.5 only supports the ISSUER_SERIAL_NUMBER CERT_ID choice.
- //
- // If HashEncryptionAlgorithm is present and not NULL its used instead of
- // the PublicKeyInfo.Algorithm.
- //
- // Note, for RSA, the hash encryption algorithm is normally the same as
- // the public key algorithm. For DSA, the hash encryption algorithm is
- // normally a DSS signature algorithm.
- //
- // pvHashEncryptionAuxInfo currently isn't used and must be set to NULL if
- // present in the data structure.
- //
- // The hCryptProv and dwKeySpec specify the private key to use. If dwKeySpec
- // == 0, then, defaults to AT_SIGNATURE.
- //
- // If the HashEncryptionAlgorithm is set to szOID_PKIX_NO_SIGNATURE, then,
- // the signature value only contains the hash octets. hCryptProv must still
- // be specified. However, since a private key isn't used the hCryptProv can be
- // acquired using CRYPT_VERIFYCONTEXT.
- //
- // If CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags
- // passed to CryptMsgOpenToEncode(), the signer hCryptProv's are released.
- //
- // pvHashAuxInfo currently isn't used and must be set to NULL.
- //
- // CMS signed messages allow the inclusion of Attribute Certs.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_SIGNER_ENCODE_INFO {
- DWORD cbSize;
- PCERT_INFO pCertInfo;
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- void *pvHashAuxInfo;
- DWORD cAuthAttr;
- PCRYPT_ATTRIBUTE rgAuthAttr;
- DWORD cUnauthAttr;
- PCRYPT_ATTRIBUTE rgUnauthAttr;
- #ifdef CMSG_SIGNER_ENCODE_INFO_HAS_CMS_FIELDS
- CERT_ID SignerId;
- CRYPT_ALGORITHM_IDENTIFIER HashEncryptionAlgorithm;
- void *pvHashEncryptionAuxInfo;
- #endif
- } CMSG_SIGNER_ENCODE_INFO, *PCMSG_SIGNER_ENCODE_INFO;
- typedef struct _CMSG_SIGNED_ENCODE_INFO {
- DWORD cbSize;
- DWORD cSigners;
- PCMSG_SIGNER_ENCODE_INFO rgSigners;
- DWORD cCertEncoded;
- PCERT_BLOB rgCertEncoded;
- DWORD cCrlEncoded;
- PCRL_BLOB rgCrlEncoded;
- #ifdef CMSG_SIGNED_ENCODE_INFO_HAS_CMS_FIELDS
- DWORD cAttrCertEncoded;
- PCERT_BLOB rgAttrCertEncoded;
- #endif
- } CMSG_SIGNED_ENCODE_INFO, *PCMSG_SIGNED_ENCODE_INFO;
- //+-------------------------------------------------------------------------
- // CMSG_ENVELOPED
- //
- // The PCERT_INFO for the rgRecipients provides the Issuer, SerialNumber
- // and PublicKeyInfo. The PublicKeyInfo.Algorithm implicitly
- // specifies the KeyEncryptionAlgorithm to be used.
- //
- // The PublicKeyInfo.PublicKey in PCERT_INFO is used to encrypt the content
- // encryption key for the recipient.
- //
- // hCryptProv is used to do the content encryption, recipient key encryption
- // and export. The hCryptProv's private keys aren't used. If hCryptProv
- // is NULL, a default hCryptProv is chosen according to the
- // ContentEncryptionAlgorithm and the first recipient KeyEncryptionAlgorithm.
- //
- // If CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags
- // passed to CryptMsgOpenToEncode(), the envelope's hCryptProv is released.
- //
- // Note: CAPI currently doesn't support more than one KeyEncryptionAlgorithm
- // per provider. This will need to be fixed.
- //
- // Currently, pvEncryptionAuxInfo is only defined for RC2 or RC4 encryption
- // algorithms. Otherwise, its not used and must be set to NULL.
- // See CMSG_RC2_AUX_INFO for the RC2 encryption algorithms.
- // See CMSG_RC4_AUX_INFO for the RC4 encryption algorithms.
- //
- // To enable SP3 compatible encryption, pvEncryptionAuxInfo should point to
- // a CMSG_SP3_COMPATIBLE_AUX_INFO data structure.
- //
- // To enable the CMS envelope enhancements, rgpRecipients must be set to
- // NULL, and rgCmsRecipients updated to point to an array of
- // CMSG_RECIPIENT_ENCODE_INFO's.
- //
- // Also, CMS envelope enhancements support the inclusion of a bag of
- // Certs, CRLs, Attribute Certs and/or Unprotected Attributes.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_RECIPIENT_ENCODE_INFO CMSG_RECIPIENT_ENCODE_INFO,
- *PCMSG_RECIPIENT_ENCODE_INFO;
- typedef struct _CMSG_ENVELOPED_ENCODE_INFO {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- CRYPT_ALGORITHM_IDENTIFIER ContentEncryptionAlgorithm;
- void *pvEncryptionAuxInfo;
- DWORD cRecipients;
- // The following array may only be used for transport recipients identified
- // by their IssuereAndSerialNumber. If rgpRecipients != NULL, then,
- // the rgCmsRecipients must be NULL.
- PCERT_INFO *rgpRecipients;
- #ifdef CMSG_ENVELOPED_ENCODE_INFO_HAS_CMS_FIELDS
- // If rgCmsRecipients != NULL, then, the above rgpRecipients must be
- // NULL.
- PCMSG_RECIPIENT_ENCODE_INFO rgCmsRecipients;
- DWORD cCertEncoded;
- PCERT_BLOB rgCertEncoded;
- DWORD cCrlEncoded;
- PCRL_BLOB rgCrlEncoded;
- DWORD cAttrCertEncoded;
- PCERT_BLOB rgAttrCertEncoded;
- DWORD cUnprotectedAttr;
- PCRYPT_ATTRIBUTE rgUnprotectedAttr;
- #endif
- } CMSG_ENVELOPED_ENCODE_INFO, *PCMSG_ENVELOPED_ENCODE_INFO;
- //+-------------------------------------------------------------------------
- // Key Transport Recipient Encode Info
- //
- // hCryptProv is used to do the recipient key encryption
- // and export. The hCryptProv's private keys aren't used.
- //
- // If hCryptProv is NULL, then, the hCryptProv specified in
- // CMSG_ENVELOPED_ENCODE_INFO is used.
- //
- // Note, even if CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags
- // passed to CryptMsgOpenToEncode(), this hCryptProv isn't released.
- //
- // CMS supports the KEY_IDENTIFIER and ISSUER_SERIAL_NUMBER CERT_IDs. PKCS #7
- // version 1.5 only supports the ISSUER_SERIAL_NUMBER CERT_ID choice.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_KEY_TRANS_RECIPIENT_ENCODE_INFO {
- DWORD cbSize;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- void *pvKeyEncryptionAuxInfo;
- HCRYPTPROV hCryptProv;
- CRYPT_BIT_BLOB RecipientPublicKey;
- CERT_ID RecipientId;
- } CMSG_KEY_TRANS_RECIPIENT_ENCODE_INFO, *PCMSG_KEY_TRANS_RECIPIENT_ENCODE_INFO;
- //+-------------------------------------------------------------------------
- // Key Agreement Recipient Encode Info
- //
- // If hCryptProv is NULL, then, the hCryptProv specified in
- // CMSG_ENVELOPED_ENCODE_INFO is used.
- //
- // For the CMSG_KEY_AGREE_STATIC_KEY_CHOICE, both the hCryptProv and
- // dwKeySpec must be specified to select the sender's private key.
- //
- // Note, even if CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags
- // passed to CryptMsgOpenToEncode(), this hCryptProv isn't released.
- //
- // CMS supports the KEY_IDENTIFIER and ISSUER_SERIAL_NUMBER CERT_IDs.
- //
- // There is 1 key choice, ephemeral originator. The originator's ephemeral
- // key is generated using the public key algorithm parameters shared
- // amongst all the recipients.
- //
- // There are 2 key choices: ephemeral originator or static sender. The
- // originator's ephemeral key is generated using the public key algorithm
- // parameters shared amongst all the recipients. For the static sender its
- // private key is used. The hCryptProv and dwKeySpec specify the private key.
- // The pSenderId identifies the certificate containing the sender's public key.
- //
- // Currently, pvKeyEncryptionAuxInfo isn't used and must be set to NULL.
- //
- // If KeyEncryptionAlgorithm.Parameters.cbData == 0, then, its Parameters
- // are updated with the encoded KeyWrapAlgorithm.
- //
- // Currently, pvKeyWrapAuxInfo is only defined for algorithms with
- // RC2. Otherwise, its not used and must be set to NULL.
- // When set for RC2 algorithms, points to a CMSG_RC2_AUX_INFO containing
- // the RC2 effective key length.
- //
- // Note, key agreement recipients are not supported in PKCS #7 version 1.5.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_RECIPIENT_ENCRYPTED_KEY_ENCODE_INFO {
- DWORD cbSize;
- CRYPT_BIT_BLOB RecipientPublicKey;
- CERT_ID RecipientId;
- // Following fields are optional and only applicable to KEY_IDENTIFIER
- // CERT_IDs.
- FILETIME Date;
- PCRYPT_ATTRIBUTE_TYPE_VALUE pOtherAttr;
- } CMSG_RECIPIENT_ENCRYPTED_KEY_ENCODE_INFO,
- *PCMSG_RECIPIENT_ENCRYPTED_KEY_ENCODE_INFO;
- typedef struct _CMSG_KEY_AGREE_RECIPIENT_ENCODE_INFO {
- DWORD cbSize;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- void *pvKeyEncryptionAuxInfo;
- CRYPT_ALGORITHM_IDENTIFIER KeyWrapAlgorithm;
- void *pvKeyWrapAuxInfo;
- // The following hCryptProv and dwKeySpec must be specified for the
- // CMSG_KEY_AGREE_STATIC_KEY_CHOICE.
- //
- // For CMSG_KEY_AGREE_EPHEMERAL_KEY_CHOICE, dwKeySpec isn't applicable
- // and hCryptProv is optional.
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- DWORD dwKeyChoice;
- union {
- // CMSG_KEY_AGREE_EPHEMERAL_KEY_CHOICE
- //
- // The ephemeral public key algorithm and parameters.
- PCRYPT_ALGORITHM_IDENTIFIER pEphemeralAlgorithm;
- // CMSG_KEY_AGREE_STATIC_KEY_CHOICE
- //
- // The CertId of the sender's certificate
- PCERT_ID pSenderId;
- };
- CRYPT_DATA_BLOB UserKeyingMaterial; // OPTIONAL
- DWORD cRecipientEncryptedKeys;
- PCMSG_RECIPIENT_ENCRYPTED_KEY_ENCODE_INFO *rgpRecipientEncryptedKeys;
- } CMSG_KEY_AGREE_RECIPIENT_ENCODE_INFO, *PCMSG_KEY_AGREE_RECIPIENT_ENCODE_INFO;
- #define CMSG_KEY_AGREE_EPHEMERAL_KEY_CHOICE 1
- #define CMSG_KEY_AGREE_STATIC_KEY_CHOICE 2
- //+-------------------------------------------------------------------------
- // Mail List Recipient Encode Info
- //
- // There is 1 choice for the KeyEncryptionKey: an already created CSP key
- // handle. For the key handle choice, hCryptProv must be nonzero. This key
- // handle isn't destroyed.
- //
- // Note, even if CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags
- // passed to CryptMsgOpenToEncode(), this hCryptProv isn't released.
- //
- // Currently, pvKeyEncryptionAuxInfo is only defined for RC2 key wrap
- // algorithms. Otherwise, its not used and must be set to NULL.
- // When set for RC2 algorithms, points to a CMSG_RC2_AUX_INFO containing
- // the RC2 effective key length.
- //
- // Note, mail list recipients are not supported in PKCS #7 version 1.5.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_MAIL_LIST_RECIPIENT_ENCODE_INFO {
- DWORD cbSize;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- void *pvKeyEncryptionAuxInfo;
- HCRYPTPROV hCryptProv;
- DWORD dwKeyChoice;
- union {
- // CMSG_MAIL_LIST_HANDLE_KEY_CHOICE
- HCRYPTKEY hKeyEncryptionKey;
- // Reserve space for a potential pointer choice
- void *pvKeyEncryptionKey;
- };
- CRYPT_DATA_BLOB KeyId;
- // Following fields are optional.
- FILETIME Date;
- PCRYPT_ATTRIBUTE_TYPE_VALUE pOtherAttr;
- } CMSG_MAIL_LIST_RECIPIENT_ENCODE_INFO, *PCMSG_MAIL_LIST_RECIPIENT_ENCODE_INFO;
- #define CMSG_MAIL_LIST_HANDLE_KEY_CHOICE 1
- //+-------------------------------------------------------------------------
- // Recipient Encode Info
- //
- // Note, only key transport recipients are supported in PKCS #7 version 1.5.
- //--------------------------------------------------------------------------
- struct _CMSG_RECIPIENT_ENCODE_INFO {
- DWORD dwRecipientChoice;
- union {
- // CMSG_KEY_TRANS_RECIPIENT
- PCMSG_KEY_TRANS_RECIPIENT_ENCODE_INFO pKeyTrans;
- // CMSG_KEY_AGREE_RECIPIENT
- PCMSG_KEY_AGREE_RECIPIENT_ENCODE_INFO pKeyAgree;
- // CMSG_MAIL_LIST_RECIPIENT
- PCMSG_MAIL_LIST_RECIPIENT_ENCODE_INFO pMailList;
- };
- };
- #define CMSG_KEY_TRANS_RECIPIENT 1
- #define CMSG_KEY_AGREE_RECIPIENT 2
- #define CMSG_MAIL_LIST_RECIPIENT 3
- //+-------------------------------------------------------------------------
- // CMSG_RC2_AUX_INFO
- //
- // AuxInfo for RC2 encryption algorithms. The pvEncryptionAuxInfo field
- // in CMSG_ENCRYPTED_ENCODE_INFO should be updated to point to this
- // structure. If not specified, defaults to 40 bit.
- //
- // Note, this AuxInfo is only used when, the ContentEncryptionAlgorithm's
- // Parameter.cbData is zero. Otherwise, the Parameters is decoded to
- // get the bit length.
- //
- // If CMSG_SP3_COMPATIBLE_ENCRYPT_FLAG is set in dwBitLen, then, SP3
- // compatible encryption is done and the bit length is ignored.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_RC2_AUX_INFO {
- DWORD cbSize;
- DWORD dwBitLen;
- } CMSG_RC2_AUX_INFO, *PCMSG_RC2_AUX_INFO;
- //+-------------------------------------------------------------------------
- // CMSG_SP3_COMPATIBLE_AUX_INFO
- //
- // AuxInfo for enabling SP3 compatible encryption.
- //
- // The CMSG_SP3_COMPATIBLE_ENCRYPT_FLAG is set in dwFlags to enable SP3
- // compatible encryption. When set, uses zero salt instead of no salt,
- // the encryption algorithm parameters are NULL instead of containing the
- // encoded RC2 parameters or encoded IV octet string and the encrypted
- // symmetric key is encoded little endian instead of big endian.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_SP3_COMPATIBLE_AUX_INFO {
- DWORD cbSize;
- DWORD dwFlags;
- } CMSG_SP3_COMPATIBLE_AUX_INFO, *PCMSG_SP3_COMPATIBLE_AUX_INFO;
- #define CMSG_SP3_COMPATIBLE_ENCRYPT_FLAG 0x80000000
- //+-------------------------------------------------------------------------
- // CMSG_RC4_AUX_INFO
- //
- // AuxInfo for RC4 encryption algorithms. The pvEncryptionAuxInfo field
- // in CMSG_ENCRYPTED_ENCODE_INFO should be updated to point to this
- // structure. If not specified, uses the CSP's default bit length with no
- // salt. Note, the base CSP has a 40 bit default and the enhanced CSP has
- // a 128 bit default.
- //
- // If CMSG_RC4_NO_SALT_FLAG is set in dwBitLen, then, no salt is generated.
- // Otherwise, (128 - dwBitLen)/8 bytes of salt are generated and encoded
- // as an OCTET STRING in the algorithm parameters field.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_RC4_AUX_INFO {
- DWORD cbSize;
- DWORD dwBitLen;
- } CMSG_RC4_AUX_INFO, *PCMSG_RC4_AUX_INFO;
- #define CMSG_RC4_NO_SALT_FLAG 0x40000000
- //+-------------------------------------------------------------------------
- // CMSG_SIGNED_AND_ENVELOPED
- //
- // For PKCS #7, a signed and enveloped message doesn't have the
- // signer's authenticated or unauthenticated attributes. Otherwise, a
- // combination of the CMSG_SIGNED_ENCODE_INFO and CMSG_ENVELOPED_ENCODE_INFO.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_SIGNED_AND_ENVELOPED_ENCODE_INFO {
- DWORD cbSize;
- CMSG_SIGNED_ENCODE_INFO SignedInfo;
- CMSG_ENVELOPED_ENCODE_INFO EnvelopedInfo;
- } CMSG_SIGNED_AND_ENVELOPED_ENCODE_INFO, *PCMSG_SIGNED_AND_ENVELOPED_ENCODE_INFO;
- //+-------------------------------------------------------------------------
- // CMSG_HASHED
- //
- // hCryptProv is used to do the hash. Doesn't need to use a private key.
- //
- // If CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags
- // passed to CryptMsgOpenToEncode(), the hCryptProv is released.
- //
- // If fDetachedHash is set, then, the encoded message doesn't contain
- // any content (its treated as NULL Data)
- //
- // pvHashAuxInfo currently isn't used and must be set to NULL.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_HASHED_ENCODE_INFO {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- void *pvHashAuxInfo;
- } CMSG_HASHED_ENCODE_INFO, *PCMSG_HASHED_ENCODE_INFO;
- //+-------------------------------------------------------------------------
- // CMSG_ENCRYPTED
- //
- // The key used to encrypt the message is identified outside of the message
- // content (for example, password).
- //
- // The content input to CryptMsgUpdate has already been encrypted.
- //
- // pvEncryptionAuxInfo currently isn't used and must be set to NULL.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_ENCRYPTED_ENCODE_INFO {
- DWORD cbSize;
- CRYPT_ALGORITHM_IDENTIFIER ContentEncryptionAlgorithm;
- void *pvEncryptionAuxInfo;
- } CMSG_ENCRYPTED_ENCODE_INFO, *PCMSG_ENCRYPTED_ENCODE_INFO;
- //+-------------------------------------------------------------------------
- // This parameter allows messages to be of variable length with streamed
- // output.
- //
- // By default, messages are of a definite length and
- // CryptMsgGetParam(CMSG_CONTENT_PARAM) is
- // called to get the cryptographically processed content. Until closed,
- // the handle keeps a copy of the processed content.
- //
- // With streamed output, the processed content can be freed as its streamed.
- //
- // If the length of the content to be updated is known at the time of the
- // open, then, ContentLength should be set to that length. Otherwise, it
- // should be set to CMSG_INDEFINITE_LENGTH.
- //--------------------------------------------------------------------------
- typedef BOOL (WINAPI *PFN_CMSG_STREAM_OUTPUT)(
- IN const void *pvArg,
- IN BYTE *pbData,
- IN DWORD cbData,
- IN BOOL fFinal
- );
- #define CMSG_INDEFINITE_LENGTH (0xFFFFFFFF)
- typedef struct _CMSG_STREAM_INFO {
- DWORD cbContent;
- PFN_CMSG_STREAM_OUTPUT pfnStreamOutput;
- void *pvArg;
- } CMSG_STREAM_INFO, *PCMSG_STREAM_INFO;
- //+-------------------------------------------------------------------------
- // Open dwFlags
- //--------------------------------------------------------------------------
- #define CMSG_BARE_CONTENT_FLAG 0x00000001
- #define CMSG_LENGTH_ONLY_FLAG 0x00000002
- #define CMSG_DETACHED_FLAG 0x00000004
- #define CMSG_AUTHENTICATED_ATTRIBUTES_FLAG 0x00000008
- #define CMSG_CONTENTS_OCTETS_FLAG 0x00000010
- #define CMSG_MAX_LENGTH_FLAG 0x00000020
- // When set, nonData type inner content is encapsulated within an
- // OCTET STRING. Applicable to both Signed and Enveloped messages.
- #define CMSG_CMS_ENCAPSULATED_CONTENT_FLAG 0x00000040
- // If set, then, the hCryptProv passed to CryptMsgOpenToEncode or
- // CryptMsgOpenToDecode is released on the final CryptMsgClose.
- // Not released if CryptMsgOpenToEncode or CryptMsgOpenToDecode fails.
- //
- // Note, the envelope recipient hCryptProv's aren't released.
- #define CMSG_CRYPT_RELEASE_CONTEXT_FLAG 0x00008000
- //+-------------------------------------------------------------------------
- // Open a cryptographic message for encoding
- //
- // If CMSG_BARE_CONTENT_FLAG is specified for a streamed message,
- // the streamed output will not have an outer ContentInfo wrapper. This
- // makes it suitable to be streamed into an enclosing message.
- //
- // The pStreamInfo parameter needs to be set to stream the encoded message
- // output.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCRYPTMSG
- WINAPI
- CryptMsgOpenToEncode(
- IN DWORD dwMsgEncodingType,
- IN DWORD dwFlags,
- IN DWORD dwMsgType,
- IN void const *pvMsgEncodeInfo,
- IN OPTIONAL LPSTR pszInnerContentObjID,
- IN OPTIONAL PCMSG_STREAM_INFO pStreamInfo
- );
- //+-------------------------------------------------------------------------
- // Calculate the length of an encoded cryptographic message.
- //
- // Calculates the length of the encoded message given the
- // message type, encoding parameters and total length of
- // the data to be updated. Note, this might not be the exact length. However,
- // it will always be greater than or equal to the actual length.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CryptMsgCalculateEncodedLength(
- IN DWORD dwMsgEncodingType,
- IN DWORD dwFlags,
- IN DWORD dwMsgType,
- IN void const *pvMsgEncodeInfo,
- IN OPTIONAL LPSTR pszInnerContentObjID,
- IN DWORD cbData
- );
- //+-------------------------------------------------------------------------
- // Open a cryptographic message for decoding
- //
- // hCryptProv specifies the crypto provider to use for hashing and/or
- // decrypting the message. If hCryptProv is NULL, a default crypt provider
- // is used.
- //
- // Currently pRecipientInfo isn't used and should be set to NULL.
- //
- // The pStreamInfo parameter needs to be set to stream the decoded content
- // output.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCRYPTMSG
- WINAPI
- CryptMsgOpenToDecode(
- IN DWORD dwMsgEncodingType,
- IN DWORD dwFlags,
- IN DWORD dwMsgType,
- IN HCRYPTPROV hCryptProv,
- IN OPTIONAL PCERT_INFO pRecipientInfo,
- IN OPTIONAL PCMSG_STREAM_INFO pStreamInfo
- );
- //+-------------------------------------------------------------------------
- // Duplicate a cryptographic message handle
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCRYPTMSG
- WINAPI
- CryptMsgDuplicate(
- IN HCRYPTMSG hCryptMsg
- );
- //+-------------------------------------------------------------------------
- // Close a cryptographic message handle
- //
- // LastError is preserved unless FALSE is returned.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptMsgClose(
- IN HCRYPTMSG hCryptMsg
- );
- //+-------------------------------------------------------------------------
- // Update the content of a cryptographic message. Depending on how the
- // message was opened, the content is either encoded or decoded.
- //
- // This function is repetitively called to append to the message content.
- // fFinal is set to identify the last update. On fFinal, the encode/decode
- // is completed. The encoded/decoded content and the decoded parameters
- // are valid until the open and all duplicated handles are closed.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptMsgUpdate(
- IN HCRYPTMSG hCryptMsg,
- IN const BYTE *pbData,
- IN DWORD cbData,
- IN BOOL fFinal
- );
- //+-------------------------------------------------------------------------
- // Get a parameter after encoding/decoding a cryptographic message. Called
- // after the final CryptMsgUpdate. Only the CMSG_CONTENT_PARAM and
- // CMSG_COMPUTED_HASH_PARAM are valid for an encoded message.
- //
- // For an encoded HASHED message, the CMSG_COMPUTED_HASH_PARAM can be got
- // before any CryptMsgUpdates to get its length.
- //
- // The pvData type definition depends on the dwParamType value.
- //
- // Elements pointed to by fields in the pvData structure follow the
- // structure. Therefore, *pcbData may exceed the size of the structure.
- //
- // Upon input, if *pcbData == 0, then, *pcbData is updated with the length
- // of the data and the pvData parameter is ignored.
- //
- // Upon return, *pcbData is updated with the length of the data.
- //
- // The OBJID BLOBs returned in the pvData structures point to
- // their still encoded representation. The appropriate functions
- // must be called to decode the information.
- //
- // See below for a list of the parameters to get.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptMsgGetParam(
- IN HCRYPTMSG hCryptMsg,
- IN DWORD dwParamType,
- IN DWORD dwIndex,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- //+-------------------------------------------------------------------------
- // Get parameter types and their corresponding data structure definitions.
- //--------------------------------------------------------------------------
- #define CMSG_TYPE_PARAM 1
- #define CMSG_CONTENT_PARAM 2
- #define CMSG_BARE_CONTENT_PARAM 3
- #define CMSG_INNER_CONTENT_TYPE_PARAM 4
- #define CMSG_SIGNER_COUNT_PARAM 5
- #define CMSG_SIGNER_INFO_PARAM 6
- #define CMSG_SIGNER_CERT_INFO_PARAM 7
- #define CMSG_SIGNER_HASH_ALGORITHM_PARAM 8
- #define CMSG_SIGNER_AUTH_ATTR_PARAM 9
- #define CMSG_SIGNER_UNAUTH_ATTR_PARAM 10
- #define CMSG_CERT_COUNT_PARAM 11
- #define CMSG_CERT_PARAM 12
- #define CMSG_CRL_COUNT_PARAM 13
- #define CMSG_CRL_PARAM 14
- #define CMSG_ENVELOPE_ALGORITHM_PARAM 15
- #define CMSG_RECIPIENT_COUNT_PARAM 17
- #define CMSG_RECIPIENT_INDEX_PARAM 18
- #define CMSG_RECIPIENT_INFO_PARAM 19
- #define CMSG_HASH_ALGORITHM_PARAM 20
- #define CMSG_HASH_DATA_PARAM 21
- #define CMSG_COMPUTED_HASH_PARAM 22
- #define CMSG_ENCRYPT_PARAM 26
- #define CMSG_ENCRYPTED_DIGEST 27
- #define CMSG_ENCODED_SIGNER 28
- #define CMSG_ENCODED_MESSAGE 29
- #define CMSG_VERSION_PARAM 30
- #define CMSG_ATTR_CERT_COUNT_PARAM 31
- #define CMSG_ATTR_CERT_PARAM 32
- #define CMSG_CMS_RECIPIENT_COUNT_PARAM 33
- #define CMSG_CMS_RECIPIENT_INDEX_PARAM 34
- #define CMSG_CMS_RECIPIENT_ENCRYPTED_KEY_INDEX_PARAM 35
- #define CMSG_CMS_RECIPIENT_INFO_PARAM 36
- #define CMSG_UNPROTECTED_ATTR_PARAM 37
- #define CMSG_SIGNER_CERT_ID_PARAM 38
- #define CMSG_CMS_SIGNER_INFO_PARAM 39
- //+-------------------------------------------------------------------------
- // CMSG_TYPE_PARAM
- //
- // The type of the decoded message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CONTENT_PARAM
- //
- // The encoded content of a cryptographic message. Depending on how the
- // message was opened, the content is either the whole PKCS#7
- // message (opened to encode) or the inner content (opened to decode).
- // In the decode case, the decrypted content is returned, if enveloped.
- // If not enveloped, and if the inner content is of type DATA, the returned
- // data is the contents octets of the inner content.
- //
- // pvData points to the buffer receiving the content bytes
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_BARE_CONTENT_PARAM
- //
- // The encoded content of an encoded cryptographic message, without the
- // outer layer of ContentInfo. That is, only the encoding of the
- // ContentInfo.content field is returned.
- //
- // pvData points to the buffer receiving the content bytes
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_INNER_CONTENT_TYPE_PARAM
- //
- // The type of the inner content of a decoded cryptographic message,
- // in the form of a NULL-terminated object identifier string
- // (eg. "1.2.840.113549.1.7.1").
- //
- // pvData points to the buffer receiving the object identifier string
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_SIGNER_COUNT_PARAM
- //
- // Count of signers in a SIGNED or SIGNED_AND_ENVELOPED message
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_SIGNER_CERT_INFO_PARAM
- //
- // To get all the signers, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. SignerCount - 1.
- //
- // pvData points to a CERT_INFO struct.
- //
- // Only the following fields have been updated in the CERT_INFO struct:
- // Issuer and SerialNumber.
- //
- // Note, if the KEYID choice was selected for a CMS SignerId, then, the
- // SerialNumber is 0 and the Issuer is encoded containing a single RDN with a
- // single Attribute whose OID is szOID_KEYID_RDN, value type is
- // CERT_RDN_OCTET_STRING and value is the KEYID. When the
- // CertGetSubjectCertificateFromStore and
- // CertFindCertificateInStore(CERT_FIND_SUBJECT_CERT) APIs see this
- // special KEYID Issuer and SerialNumber, they do a KEYID match.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_SIGNER_INFO_PARAM
- //
- // To get all the signers, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. SignerCount - 1.
- //
- // pvData points to a CMSG_SIGNER_INFO struct.
- //
- // Note, if the KEYID choice was selected for a CMS SignerId, then, the
- // SerialNumber is 0 and the Issuer is encoded containing a single RDN with a
- // single Attribute whose OID is szOID_KEYID_RDN, value type is
- // CERT_RDN_OCTET_STRING and value is the KEYID. When the
- // CertGetSubjectCertificateFromStore and
- // CertFindCertificateInStore(CERT_FIND_SUBJECT_CERT) APIs see this
- // special KEYID Issuer and SerialNumber, they do a KEYID match.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_SIGNER_INFO {
- DWORD dwVersion;
- CERT_NAME_BLOB Issuer;
- CRYPT_INTEGER_BLOB SerialNumber;
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- CRYPT_ALGORITHM_IDENTIFIER HashEncryptionAlgorithm;
- CRYPT_DATA_BLOB EncryptedHash;
- CRYPT_ATTRIBUTES AuthAttrs;
- CRYPT_ATTRIBUTES UnauthAttrs;
- } CMSG_SIGNER_INFO, *PCMSG_SIGNER_INFO;
- //+-------------------------------------------------------------------------
- // CMSG_SIGNER_CERT_ID_PARAM
- //
- // To get all the signers, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. SignerCount - 1.
- //
- // pvData points to a CERT_ID struct.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CMS_SIGNER_INFO_PARAM
- //
- // Same as CMSG_SIGNER_INFO_PARAM, except, contains SignerId instead of
- // Issuer and SerialNumber.
- //
- // To get all the signers, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. SignerCount - 1.
- //
- // pvData points to a CMSG_CMS_SIGNER_INFO struct.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CMS_SIGNER_INFO {
- DWORD dwVersion;
- CERT_ID SignerId;
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- CRYPT_ALGORITHM_IDENTIFIER HashEncryptionAlgorithm;
- CRYPT_DATA_BLOB EncryptedHash;
- CRYPT_ATTRIBUTES AuthAttrs;
- CRYPT_ATTRIBUTES UnauthAttrs;
- } CMSG_CMS_SIGNER_INFO, *PCMSG_CMS_SIGNER_INFO;
- //+-------------------------------------------------------------------------
- // CMSG_SIGNER_HASH_ALGORITHM_PARAM
- //
- // This parameter specifies the HashAlgorithm that was used for the signer.
- //
- // Set dwIndex to iterate through all the signers.
- //
- // pvData points to an CRYPT_ALGORITHM_IDENTIFIER struct.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_SIGNER_AUTH_ATTR_PARAM
- //
- // The authenticated attributes for the signer.
- //
- // Set dwIndex to iterate through all the signers.
- //
- // pvData points to a CMSG_ATTR struct.
- //--------------------------------------------------------------------------
- typedef CRYPT_ATTRIBUTES CMSG_ATTR;
- typedef CRYPT_ATTRIBUTES *PCMSG_ATTR;
- //+-------------------------------------------------------------------------
- // CMSG_SIGNER_UNAUTH_ATTR_PARAM
- //
- // The unauthenticated attributes for the signer.
- //
- // Set dwIndex to iterate through all the signers.
- //
- // pvData points to a CMSG_ATTR struct.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CERT_COUNT_PARAM
- //
- // Count of certificates in a SIGNED or SIGNED_AND_ENVELOPED message.
- //
- // CMS, also supports certificates in an ENVELOPED message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CERT_PARAM
- //
- // To get all the certificates, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. CertCount - 1.
- //
- // pvData points to an array of the certificate's encoded bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CRL_COUNT_PARAM
- //
- // Count of CRLs in a SIGNED or SIGNED_AND_ENVELOPED message.
- //
- // CMS, also supports CRLs in an ENVELOPED message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CRL_PARAM
- //
- // To get all the CRLs, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. CrlCount - 1.
- //
- // pvData points to an array of the CRL's encoded bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_ENVELOPE_ALGORITHM_PARAM
- //
- // The ContentEncryptionAlgorithm that was used in
- // an ENVELOPED or SIGNED_AND_ENVELOPED message.
- //
- // For streaming you must be able to successfully get this parameter before
- // doing a CryptMsgControl decrypt.
- //
- // pvData points to an CRYPT_ALGORITHM_IDENTIFIER struct.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_RECIPIENT_COUNT_PARAM
- //
- // Count of recipients in an ENVELOPED or SIGNED_AND_ENVELOPED message.
- //
- // Count of key transport recepients.
- //
- // The CMSG_CMS_RECIPIENT_COUNT_PARAM has the total count of
- // recipients (it also includes key agree and mail list recipients).
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_RECIPIENT_INDEX_PARAM
- //
- // Index of the recipient used to decrypt an ENVELOPED or SIGNED_AND_ENVELOPED
- // message.
- //
- // Index of a key transport recipient. If a non key transport
- // recipient was used to decrypt, fails with LastError set to
- // CRYPT_E_INVALID_INDEX.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_RECIPIENT_INFO_PARAM
- //
- // To get all the recipients, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. RecipientCount - 1.
- //
- // Only returns the key transport recepients.
- //
- // The CMSG_CMS_RECIPIENT_INFO_PARAM returns all recipients.
- //
- // pvData points to a CERT_INFO struct.
- //
- // Only the following fields have been updated in the CERT_INFO struct:
- // Issuer, SerialNumber and PublicKeyAlgorithm. The PublicKeyAlgorithm
- // specifies the KeyEncryptionAlgorithm that was used.
- //
- // Note, if the KEYID choice was selected for a key transport recipient, then,
- // the SerialNumber is 0 and the Issuer is encoded containing a single RDN
- // with a single Attribute whose OID is szOID_KEYID_RDN, value type is
- // CERT_RDN_OCTET_STRING and value is the KEYID. When the
- // CertGetSubjectCertificateFromStore and
- // CertFindCertificateInStore(CERT_FIND_SUBJECT_CERT) APIs see this
- // special KEYID Issuer and SerialNumber, they do a KEYID match.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_HASH_ALGORITHM_PARAM
- //
- // The HashAlgorithm in a HASHED message.
- //
- // pvData points to an CRYPT_ALGORITHM_IDENTIFIER struct.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_HASH_DATA_PARAM
- //
- // The hash in a HASHED message.
- //
- // pvData points to an array of bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_COMPUTED_HASH_PARAM
- //
- // The computed hash for a HASHED message.
- // This may be called for either an encoded or decoded message.
- //
- // Also, the computed hash for one of the signer's in a SIGNED message.
- // It may be called for either an encoded or decoded message after the
- // final update. Set dwIndex to iterate through all the signers.
- //
- // pvData points to an array of bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_ENCRYPT_PARAM
- //
- // The ContentEncryptionAlgorithm that was used in an ENCRYPTED message.
- //
- // pvData points to an CRYPT_ALGORITHM_IDENTIFIER struct.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_ENCODED_MESSAGE
- //
- // The full encoded message. This is useful in the case of a decoded
- // message which has been modified (eg. a signed-data or
- // signed-and-enveloped-data message which has been countersigned).
- //
- // pvData points to an array of the message's encoded bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_VERSION_PARAM
- //
- // The version of the decoded message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- #define CMSG_SIGNED_DATA_V1 1
- #define CMSG_SIGNED_DATA_V3 3
- #define CMSG_SIGNED_DATA_PKCS_1_5_VERSION CMSG_SIGNED_DATA_V1
- #define CMSG_SIGNED_DATA_CMS_VERSION CMSG_SIGNED_DATA_V3
- #define CMSG_SIGNER_INFO_V1 1
- #define CMSG_SIGNER_INFO_V3 3
- #define CMSG_SIGNER_INFO_PKCS_1_5_VERSION CMSG_SIGNER_INFO_V1
- #define CMSG_SIGNER_INFO_CMS_VERSION CMSG_SIGNER_INFO_V3
- #define CMSG_HASHED_DATA_V0 0
- #define CMSG_HASHED_DATA_V2 2
- #define CMSG_HASHED_DATA_PKCS_1_5_VERSION CMSG_HASHED_DATA_V0
- #define CMSG_HASHED_DATA_CMS_VERSION CMSG_HASHED_DATA_V2
- #define CMSG_ENVELOPED_DATA_V0 0
- #define CMSG_ENVELOPED_DATA_V2 2
- #define CMSG_ENVELOPED_DATA_PKCS_1_5_VERSION CMSG_ENVELOPED_DATA_V0
- #define CMSG_ENVELOPED_DATA_CMS_VERSION CMSG_ENVELOPED_DATA_V2
- //+-------------------------------------------------------------------------
- // CMSG_ATTR_CERT_COUNT_PARAM
- //
- // Count of attribute certificates in a SIGNED or ENVELOPED message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_ATTR_CERT_PARAM
- //
- // To get all the attribute certificates, repetitively call CryptMsgGetParam,
- // with dwIndex set to 0 .. AttrCertCount - 1.
- //
- // pvData points to an array of the attribute certificate's encoded bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CMS_RECIPIENT_COUNT_PARAM
- //
- // Count of all CMS recipients in an ENVELOPED message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CMS_RECIPIENT_INDEX_PARAM
- //
- // Index of the CMS recipient used to decrypt an ENVELOPED message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CMS_RECIPIENT_ENCRYPTED_KEY_INDEX_PARAM
- //
- // For a CMS key agreement recipient, the index of the encrypted key
- // used to decrypt an ENVELOPED message.
- //
- // pvData points to a DWORD
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CMS_RECIPIENT_INFO_PARAM
- //
- // To get all the CMS recipients, repetitively call CryptMsgGetParam, with
- // dwIndex set to 0 .. CmsRecipientCount - 1.
- //
- // pvData points to a CMSG_CMS_RECIPIENT_INFO struct.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_KEY_TRANS_RECIPIENT_INFO {
- DWORD dwVersion;
- // Currently, only ISSUER_SERIAL_NUMBER or KEYID choices
- CERT_ID RecipientId;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- CRYPT_DATA_BLOB EncryptedKey;
- } CMSG_KEY_TRANS_RECIPIENT_INFO, *PCMSG_KEY_TRANS_RECIPIENT_INFO;
- typedef struct _CMSG_RECIPIENT_ENCRYPTED_KEY_INFO {
- // Currently, only ISSUER_SERIAL_NUMBER or KEYID choices
- CERT_ID RecipientId;
- CRYPT_DATA_BLOB EncryptedKey;
- // The following optional fields are only applicable to KEYID choice
- FILETIME Date;
- PCRYPT_ATTRIBUTE_TYPE_VALUE pOtherAttr;
- } CMSG_RECIPIENT_ENCRYPTED_KEY_INFO, *PCMSG_RECIPIENT_ENCRYPTED_KEY_INFO;
- typedef struct _CMSG_KEY_AGREE_RECIPIENT_INFO {
- DWORD dwVersion;
- DWORD dwOriginatorChoice;
- union {
- // CMSG_KEY_AGREE_ORIGINATOR_CERT
- CERT_ID OriginatorCertId;
- // CMSG_KEY_AGREE_ORIGINATOR_PUBLIC_KEY
- CERT_PUBLIC_KEY_INFO OriginatorPublicKeyInfo;
- };
- CRYPT_DATA_BLOB UserKeyingMaterial;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- DWORD cRecipientEncryptedKeys;
- PCMSG_RECIPIENT_ENCRYPTED_KEY_INFO *rgpRecipientEncryptedKeys;
- } CMSG_KEY_AGREE_RECIPIENT_INFO, *PCMSG_KEY_AGREE_RECIPIENT_INFO;
- #define CMSG_KEY_AGREE_ORIGINATOR_CERT 1
- #define CMSG_KEY_AGREE_ORIGINATOR_PUBLIC_KEY 2
- typedef struct _CMSG_MAIL_LIST_RECIPIENT_INFO {
- DWORD dwVersion;
- CRYPT_DATA_BLOB KeyId;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- CRYPT_DATA_BLOB EncryptedKey;
- // The following fields are optional
- FILETIME Date;
- PCRYPT_ATTRIBUTE_TYPE_VALUE pOtherAttr;
- } CMSG_MAIL_LIST_RECIPIENT_INFO, *PCMSG_MAIL_LIST_RECIPIENT_INFO;
- typedef struct _CMSG_CMS_RECIPIENT_INFO {
- DWORD dwRecipientChoice;
- union {
- // CMSG_KEY_TRANS_RECIPIENT
- PCMSG_KEY_TRANS_RECIPIENT_INFO pKeyTrans;
- // CMSG_KEY_AGREE_RECIPIENT
- PCMSG_KEY_AGREE_RECIPIENT_INFO pKeyAgree;
- // CMSG_MAIL_LIST_RECIPIENT
- PCMSG_MAIL_LIST_RECIPIENT_INFO pMailList;
- };
- } CMSG_CMS_RECIPIENT_INFO, *PCMSG_CMS_RECIPIENT_INFO;
- // dwVersion numbers for the KeyTrans, KeyAgree and MailList recipients
- #define CMSG_ENVELOPED_RECIPIENT_V0 0
- #define CMSG_ENVELOPED_RECIPIENT_V2 2
- #define CMSG_ENVELOPED_RECIPIENT_V3 3
- #define CMSG_ENVELOPED_RECIPIENT_V4 4
- #define CMSG_KEY_TRANS_PKCS_1_5_VERSION CMSG_ENVELOPED_RECIPIENT_V0
- #define CMSG_KEY_TRANS_CMS_VERSION CMSG_ENVELOPED_RECIPIENT_V2
- #define CMSG_KEY_AGREE_VERSION CMSG_ENVELOPED_RECIPIENT_V3
- #define CMSG_MAIL_LIST_VERSION CMSG_ENVELOPED_RECIPIENT_V4
- //+-------------------------------------------------------------------------
- // CMSG_UNPROTECTED_ATTR_PARAM
- //
- // The unprotected attributes in the envelped message.
- //
- // pvData points to a CMSG_ATTR struct.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Perform a special "control" function after the final CryptMsgUpdate of a
- // encoded/decoded cryptographic message.
- //
- // The dwCtrlType parameter specifies the type of operation to be performed.
- //
- // The pvCtrlPara definition depends on the dwCtrlType value.
- //
- // See below for a list of the control operations and their pvCtrlPara
- // type definition.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptMsgControl(
- IN HCRYPTMSG hCryptMsg,
- IN DWORD dwFlags,
- IN DWORD dwCtrlType,
- IN void const *pvCtrlPara
- );
- //+-------------------------------------------------------------------------
- // Message control types
- //--------------------------------------------------------------------------
- #define CMSG_CTRL_VERIFY_SIGNATURE 1
- #define CMSG_CTRL_DECRYPT 2
- #define CMSG_CTRL_VERIFY_HASH 5
- #define CMSG_CTRL_ADD_SIGNER 6
- #define CMSG_CTRL_DEL_SIGNER 7
- #define CMSG_CTRL_ADD_SIGNER_UNAUTH_ATTR 8
- #define CMSG_CTRL_DEL_SIGNER_UNAUTH_ATTR 9
- #define CMSG_CTRL_ADD_CERT 10
- #define CMSG_CTRL_DEL_CERT 11
- #define CMSG_CTRL_ADD_CRL 12
- #define CMSG_CTRL_DEL_CRL 13
- #define CMSG_CTRL_ADD_ATTR_CERT 14
- #define CMSG_CTRL_DEL_ATTR_CERT 15
- #define CMSG_CTRL_KEY_TRANS_DECRYPT 16
- #define CMSG_CTRL_KEY_AGREE_DECRYPT 17
- #define CMSG_CTRL_MAIL_LIST_DECRYPT 18
- #define CMSG_CTRL_VERIFY_SIGNATURE_EX 19
- #define CMSG_CTRL_ADD_CMS_SIGNER_INFO 20
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_VERIFY_SIGNATURE
- //
- // Verify the signature of a SIGNED or SIGNED_AND_ENVELOPED
- // message after it has been decoded.
- //
- // For a SIGNED_AND_ENVELOPED message, called after
- // CryptMsgControl(CMSG_CTRL_DECRYPT), if CryptMsgOpenToDecode was called
- // with a NULL pRecipientInfo.
- //
- // pvCtrlPara points to a CERT_INFO struct.
- //
- // The CERT_INFO contains the Issuer and SerialNumber identifying
- // the Signer of the message. The CERT_INFO also contains the
- // PublicKeyInfo
- // used to verify the signature. The cryptographic provider specified
- // in CryptMsgOpenToDecode is used.
- //
- // Note, if the message contains CMS signers identified by KEYID, then,
- // the CERT_INFO's Issuer and SerialNumber is ignored and only the public
- // key is used to find a signer whose signature verifies.
- //
- // The following CMSG_CTRL_VERIFY_SIGNATURE_EX should be used instead.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_VERIFY_SIGNATURE_EX
- //
- // Verify the signature of a SIGNED message after it has been decoded.
- //
- // pvCtrlPara points to the following CMSG_CTRL_VERIFY_SIGNATURE_EX_PARA.
- //
- // If hCryptProv is NULL, uses the cryptographic provider specified in
- // CryptMsgOpenToDecode. If CryptMsgOpenToDecode's hCryptProv is also NULL,
- // gets default provider according to the signer's public key OID.
- //
- // dwSignerIndex is the index of the signer to use to verify the signature.
- //
- // The signer can be a pointer to a CERT_PUBLIC_KEY_INFO, certificate
- // context or a chain context.
- //
- // If the signer's HashEncryptionAlgorithm is szOID_PKIX_NO_SIGNATURE, then,
- // the signature is expected to contain the hash octets. Only dwSignerType
- // of CMSG_VERIFY_SIGNER_NULL may be specified to verify this no signature
- // case.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CTRL_VERIFY_SIGNATURE_EX_PARA {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- DWORD dwSignerIndex;
- DWORD dwSignerType;
- void *pvSigner;
- } CMSG_CTRL_VERIFY_SIGNATURE_EX_PARA, *PCMSG_CTRL_VERIFY_SIGNATURE_EX_PARA;
- // Signer Types
- #define CMSG_VERIFY_SIGNER_PUBKEY 1
- // pvSigner :: PCERT_PUBLIC_KEY_INFO
- #define CMSG_VERIFY_SIGNER_CERT 2
- // pvSigner :: PCCERT_CONTEXT
- #define CMSG_VERIFY_SIGNER_CHAIN 3
- // pvSigner :: PCCERT_CHAIN_CONTEXT
- #define CMSG_VERIFY_SIGNER_NULL 4
- // pvSigner :: NULL
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_DECRYPT
- //
- // Decrypt an ENVELOPED or SIGNED_AND_ENVELOPED message after it has been
- // decoded.
- //
- // This decrypt is only applicable to key transport recipients.
- //
- // hCryptProv and dwKeySpec specify the private key to use. For dwKeySpec ==
- // 0, defaults to AT_KEYEXCHANGE.
- //
- // If CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags passed
- // to CryptMsgControl, then, the hCryptProv is released on the final
- // CryptMsgClose. Not released if CryptMsgControl fails.
- //
- // dwRecipientIndex is the index of the recipient in the message associated
- // with the hCryptProv's private key.
- //
- // The dwRecipientIndex is the index of a key transport recipient.
- //
- // Note, the message can only be decrypted once.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CTRL_DECRYPT_PARA {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- DWORD dwRecipientIndex;
- } CMSG_CTRL_DECRYPT_PARA, *PCMSG_CTRL_DECRYPT_PARA;
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_KEY_TRANS_DECRYPT
- //
- // Decrypt an ENVELOPED message after it has been decoded for a key
- // transport recipient.
- //
- // hCryptProv and dwKeySpec specify the private key to use. For dwKeySpec ==
- // 0, defaults to AT_KEYEXCHANGE.
- //
- // If CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags passed
- // to CryptMsgControl, then, the hCryptProv is released on the final
- // CryptMsgClose. Not released if CryptMsgControl fails.
- //
- // pKeyTrans points to the CMSG_KEY_TRANS_RECIPIENT_INFO obtained via
- // CryptMsgGetParam(CMSG_CMS_RECIPIENT_INFO_PARAM)
- //
- // dwRecipientIndex is the index of the recipient in the message associated
- // with the hCryptProv's private key.
- //
- // Note, the message can only be decrypted once.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CTRL_KEY_TRANS_DECRYPT_PARA {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- PCMSG_KEY_TRANS_RECIPIENT_INFO pKeyTrans;
- DWORD dwRecipientIndex;
- } CMSG_CTRL_KEY_TRANS_DECRYPT_PARA, *PCMSG_CTRL_KEY_TRANS_DECRYPT_PARA;
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_KEY_AGREE_DECRYPT
- //
- // Decrypt an ENVELOPED message after it has been decoded for a key
- // agreement recipient.
- //
- // hCryptProv and dwKeySpec specify the private key to use. For dwKeySpec ==
- // 0, defaults to AT_KEYEXCHANGE.
- //
- // If CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags passed
- // to CryptMsgControl, then, the hCryptProv is released on the final
- // CryptMsgClose. Not released if CryptMsgControl fails.
- //
- // pKeyAgree points to the CMSG_KEY_AGREE_RECIPIENT_INFO obtained via
- // CryptMsgGetParam(CMSG_CMS_RECIPIENT_INFO_PARAM) for dwRecipientIndex.
- //
- // dwRecipientIndex, dwRecipientEncryptedKeyIndex are the indices of the
- // recipient's encrypted key in the message associated with the hCryptProv's
- // private key.
- //
- // OriginatorPublicKey is the originator's public key obtained from either
- // the originator's certificate or the CMSG_KEY_AGREE_RECIPIENT_INFO obtained
- // via the CMSG_CMS_RECIPIENT_INFO_PARAM.
- //
- // Note, the message can only be decrypted once.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CTRL_KEY_AGREE_DECRYPT_PARA {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- PCMSG_KEY_AGREE_RECIPIENT_INFO pKeyAgree;
- DWORD dwRecipientIndex;
- DWORD dwRecipientEncryptedKeyIndex;
- CRYPT_BIT_BLOB OriginatorPublicKey;
- } CMSG_CTRL_KEY_AGREE_DECRYPT_PARA, *PCMSG_CTRL_KEY_AGREE_DECRYPT_PARA;
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_MAIL_LIST_DECRYPT
- //
- // Decrypt an ENVELOPED message after it has been decoded for a mail
- // list recipient.
- //
- // pMailList points to the CMSG_MAIL_LIST_RECIPIENT_INFO obtained via
- // CryptMsgGetParam(CMSG_CMS_RECIPIENT_INFO_PARAM) for dwRecipientIndex.
- //
- // There is 1 choice for the KeyEncryptionKey: an already created CSP key
- // handle. For the key handle choice, hCryptProv must be nonzero. This key
- // handle isn't destroyed.
- //
- // If CMSG_CRYPT_RELEASE_CONTEXT_FLAG is set in the dwFlags passed
- // to CryptMsgControl, then, the hCryptProv is released on the final
- // CryptMsgClose. Not released if CryptMsgControl fails.
- //
- // For RC2 wrap, the effective key length is obtained from the
- // KeyEncryptionAlgorithm parameters and set on the hKeyEncryptionKey before
- // decrypting.
- //
- // Note, the message can only be decrypted once.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CTRL_MAIL_LIST_DECRYPT_PARA {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- PCMSG_MAIL_LIST_RECIPIENT_INFO pMailList;
- DWORD dwRecipientIndex;
- DWORD dwKeyChoice;
- union {
- // CMSG_MAIL_LIST_HANDLE_KEY_CHOICE
- HCRYPTKEY hKeyEncryptionKey;
- // Reserve space for a potential pointer choice
- void *pvKeyEncryptionKey;
- };
- } CMSG_CTRL_MAIL_LIST_DECRYPT_PARA, *PCMSG_CTRL_MAIL_LIST_DECRYPT_PARA;
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_VERIFY_HASH
- //
- // Verify the hash of a HASHED message after it has been decoded.
- //
- // Only the hCryptMsg parameter is used, to specify the message whose
- // hash is being verified.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_ADD_SIGNER
- //
- // Add a signer to a signed-data message.
- //
- // pvCtrlPara points to a CMSG_SIGNER_ENCODE_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_ADD_CMS_SIGNER_INFO
- //
- // Add a signer to a signed-data message.
- //
- // Differs from the above, CMSG_CTRL_ADD_SIGNER, wherein, the signer info
- // already contains the signature.
- //
- // pvCtrlPara points to a CMSG_CMS_SIGNER_INFO.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_DEL_SIGNER
- //
- // Remove a signer from a signed-data or signed-and-enveloped-data message.
- //
- // pvCtrlPara points to a DWORD containing the 0-based index of the
- // signer to be removed.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_ADD_SIGNER_UNAUTH_ATTR
- //
- // Add an unauthenticated attribute to the SignerInfo of a signed-data or
- // signed-and-enveloped-data message.
- //
- // The unauthenticated attribute is input in the form of an encoded blob.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CTRL_ADD_SIGNER_UNAUTH_ATTR_PARA {
- DWORD cbSize;
- DWORD dwSignerIndex;
- CRYPT_DATA_BLOB blob;
- } CMSG_CTRL_ADD_SIGNER_UNAUTH_ATTR_PARA, *PCMSG_CTRL_ADD_SIGNER_UNAUTH_ATTR_PARA;
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_DEL_SIGNER_UNAUTH_ATTR
- //
- // Delete an unauthenticated attribute from the SignerInfo of a signed-data
- // or signed-and-enveloped-data message.
- //
- // The unauthenticated attribute to be removed is specified by
- // a 0-based index.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CTRL_DEL_SIGNER_UNAUTH_ATTR_PARA {
- DWORD cbSize;
- DWORD dwSignerIndex;
- DWORD dwUnauthAttrIndex;
- } CMSG_CTRL_DEL_SIGNER_UNAUTH_ATTR_PARA, *PCMSG_CTRL_DEL_SIGNER_UNAUTH_ATTR_PARA;
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_ADD_CERT
- //
- // Add a certificate to a signed-data or signed-and-enveloped-data message.
- //
- // pvCtrlPara points to a CRYPT_DATA_BLOB containing the certificate's
- // encoded bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_DEL_CERT
- //
- // Delete a certificate from a signed-data or signed-and-enveloped-data
- // message.
- //
- // pvCtrlPara points to a DWORD containing the 0-based index of the
- // certificate to be removed.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_ADD_CRL
- //
- // Add a CRL to a signed-data or signed-and-enveloped-data message.
- //
- // pvCtrlPara points to a CRYPT_DATA_BLOB containing the CRL's
- // encoded bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_DEL_CRL
- //
- // Delete a CRL from a signed-data or signed-and-enveloped-data message.
- //
- // pvCtrlPara points to a DWORD containing the 0-based index of the CRL
- // to be removed.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_ADD_ATTR_CERT
- //
- // Add an attribute certificate to a signed-data message.
- //
- // pvCtrlPara points to a CRYPT_DATA_BLOB containing the attribute
- // certificate's encoded bytes.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CMSG_CTRL_DEL_ATTR_CERT
- //
- // Delete an attribute certificate from a signed-data message.
- //
- // pvCtrlPara points to a DWORD containing the 0-based index of the
- // attribute certificate to be removed.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Verify a countersignature, at the SignerInfo level.
- // ie. verify that pbSignerInfoCountersignature contains the encrypted
- // hash of the encryptedDigest field of pbSignerInfo.
- //
- // hCryptProv is used to hash the encryptedDigest field of pbSignerInfo.
- // The only fields referenced from pciCountersigner are SerialNumber, Issuer,
- // and SubjectPublicKeyInfo.
- //--------------------------------------------------------------------------
- BOOL
- WINAPI
- CryptMsgVerifyCountersignatureEncoded(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwEncodingType,
- IN PBYTE pbSignerInfo,
- IN DWORD cbSignerInfo,
- IN PBYTE pbSignerInfoCountersignature,
- IN DWORD cbSignerInfoCountersignature,
- IN PCERT_INFO pciCountersigner
- );
- //+-------------------------------------------------------------------------
- // Verify a countersignature, at the SignerInfo level.
- // ie. verify that pbSignerInfoCountersignature contains the encrypted
- // hash of the encryptedDigest field of pbSignerInfo.
- //
- // hCryptProv is used to hash the encryptedDigest field of pbSignerInfo.
- //
- // The signer can be a CERT_PUBLIC_KEY_INFO, certificate context or a
- // chain context.
- //--------------------------------------------------------------------------
- BOOL
- WINAPI
- CryptMsgVerifyCountersignatureEncodedEx(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwEncodingType,
- IN PBYTE pbSignerInfo,
- IN DWORD cbSignerInfo,
- IN PBYTE pbSignerInfoCountersignature,
- IN DWORD cbSignerInfoCountersignature,
- IN DWORD dwSignerType,
- IN void *pvSigner,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved
- );
- // See CMSG_CTRL_VERIFY_SIGNATURE_EX_PARA for dwSignerType definitions
- //+-------------------------------------------------------------------------
- // Countersign an already-existing signature in a message
- //
- // dwIndex is a zero-based index of the SignerInfo to be countersigned.
- //--------------------------------------------------------------------------
- BOOL
- WINAPI
- CryptMsgCountersign(
- IN OUT HCRYPTMSG hCryptMsg,
- IN DWORD dwIndex,
- IN DWORD cCountersigners,
- IN PCMSG_SIGNER_ENCODE_INFO rgCountersigners
- );
- //+-------------------------------------------------------------------------
- // Countersign an already-existing signature (encoded SignerInfo).
- // Output an encoded SignerInfo blob, suitable for use as a countersignature
- // attribute in the unauthenticated attributes of a signed-data or
- // signed-and-enveloped-data message.
- //--------------------------------------------------------------------------
- BOOL
- WINAPI
- CryptMsgCountersignEncoded(
- IN DWORD dwEncodingType,
- IN PBYTE pbSignerInfo,
- IN DWORD cbSignerInfo,
- IN DWORD cCountersigners,
- IN PCMSG_SIGNER_ENCODE_INFO rgCountersigners,
- OUT PBYTE pbCountersignature,
- IN OUT PDWORD pcbCountersignature
- );
- //+-------------------------------------------------------------------------
- // CryptMsg OID installable functions
- //--------------------------------------------------------------------------
- typedef void * (WINAPI *PFN_CMSG_ALLOC) (
- IN size_t cb
- );
- typedef void (WINAPI *PFN_CMSG_FREE)(
- IN void *pv
- );
- // Note, the following 3 installable functions are obsolete and have been
- // replaced with GenContentEncryptKey, ExportKeyTrans, ExportKeyAgree,
- // ExportMailList, ImportKeyTrans, ImportKeyAgree and ImportMailList
- // installable functions.
- // If *phCryptProv is NULL upon entry, then, if supported, the installable
- // function should acquire a default provider and return. Note, its up
- // to the installable function to release at process detach.
- //
- // If paiEncrypt->Parameters.cbData is 0, then, the callback may optionally
- // return default encoded parameters in *ppbEncryptParameters and
- // *pcbEncryptParameters. pfnAlloc must be called for the allocation.
- #define CMSG_OID_GEN_ENCRYPT_KEY_FUNC "CryptMsgDllGenEncryptKey"
- typedef BOOL (WINAPI *PFN_CMSG_GEN_ENCRYPT_KEY) (
- IN OUT HCRYPTPROV *phCryptProv,
- IN PCRYPT_ALGORITHM_IDENTIFIER paiEncrypt,
- IN PVOID pvEncryptAuxInfo,
- IN PCERT_PUBLIC_KEY_INFO pPublicKeyInfo,
- IN PFN_CMSG_ALLOC pfnAlloc,
- OUT HCRYPTKEY *phEncryptKey,
- OUT PBYTE *ppbEncryptParameters,
- OUT PDWORD pcbEncryptParameters
- );
- #define CMSG_OID_EXPORT_ENCRYPT_KEY_FUNC "CryptMsgDllExportEncryptKey"
- typedef BOOL (WINAPI *PFN_CMSG_EXPORT_ENCRYPT_KEY) (
- IN HCRYPTPROV hCryptProv,
- IN HCRYPTKEY hEncryptKey,
- IN PCERT_PUBLIC_KEY_INFO pPublicKeyInfo,
- OUT PBYTE pbData,
- IN OUT PDWORD pcbData
- );
- #define CMSG_OID_IMPORT_ENCRYPT_KEY_FUNC "CryptMsgDllImportEncryptKey"
- typedef BOOL (WINAPI *PFN_CMSG_IMPORT_ENCRYPT_KEY) (
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwKeySpec,
- IN PCRYPT_ALGORITHM_IDENTIFIER paiEncrypt,
- IN PCRYPT_ALGORITHM_IDENTIFIER paiPubKey,
- IN PBYTE pbEncodedKey,
- IN DWORD cbEncodedKey,
- OUT HCRYPTKEY *phEncryptKey
- );
- // To get the default installable function for GenContentEncryptKey,
- // ExportKeyTrans, ExportKeyAgree, ExportMailList, ImportKeyTrans,
- // ImportKeyAgree or ImportMailList call CryptGetOIDFunctionAddress()
- // with the pszOID argument set to the following constant. dwEncodingType
- // should be set to CRYPT_ASN_ENCODING or X509_ASN_ENCODING.
- #define CMSG_DEFAULT_INSTALLABLE_FUNC_OID ((LPCSTR) 1)
- //+-------------------------------------------------------------------------
- // Content Encrypt Info
- //
- // The following data structure contains the information shared between
- // the GenContentEncryptKey and the ExportKeyTrans, ExportKeyAgree and
- // ExportMailList installable functions.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_CONTENT_ENCRYPT_INFO {
- DWORD cbSize;
- HCRYPTPROV hCryptProv;
- CRYPT_ALGORITHM_IDENTIFIER ContentEncryptionAlgorithm;
- void *pvEncryptionAuxInfo;
- DWORD cRecipients;
- PCMSG_RECIPIENT_ENCODE_INFO rgCmsRecipients;
- PFN_CMSG_ALLOC pfnAlloc;
- PFN_CMSG_FREE pfnFree;
- DWORD dwEncryptFlags;
- HCRYPTKEY hContentEncryptKey;
- DWORD dwFlags;
- } CMSG_CONTENT_ENCRYPT_INFO, *PCMSG_CONTENT_ENCRYPT_INFO;
- #define CMSG_CONTENT_ENCRYPT_PAD_ENCODED_LEN_FLAG 0x00000001
- #define CMSG_CONTENT_ENCRYPT_FREE_PARA_FLAG 0x00000001
- #define CMSG_CONTENT_ENCRYPT_RELEASE_CONTEXT_FLAG 0x00008000
- //+-------------------------------------------------------------------------
- // Upon input, ContentEncryptInfo has been initialized from the
- // EnvelopedEncodeInfo.
- //
- // Note, if rgpRecipients instead of rgCmsRecipients are set in the
- // EnvelopedEncodeInfo, then, the rgpRecipients have been converted
- // to rgCmsRecipients in the ContentEncryptInfo.
- //
- // The following fields may be changed in ContentEncryptInfo:
- // hContentEncryptKey
- // hCryptProv
- // ContentEncryptionAlgorithm.Parameters
- // dwFlags
- //
- // All other fields in the ContentEncryptInfo are READONLY.
- //
- // If CMSG_CONTENT_ENCRYPT_PAD_ENCODED_LEN_FLAG is set upon entry
- // in dwEncryptFlags, then, any potentially variable length encoded
- // output should be padded with zeroes to always obtain the
- // same maximum encoded length. This is necessary for
- // CryptMsgCalculateEncodedLength() or CryptMsgOpenToEncode() with
- // definite length streaming.
- //
- // The hContentEncryptKey must be updated.
- //
- // If hCryptProv is NULL upon input, then, it must be updated.
- // If a HCRYPTPROV is acquired that must be released, then, the
- // CMSG_CONTENT_ENCRYPT_RELEASE_CONTEXT_FLAG must be set in dwFlags.
- //
- // If ContentEncryptionAlgorithm.Parameters is updated, then, the
- // CMSG_CONTENT_ENCRYPT_FREE_PARA_FLAG must be set in dwFlags. pfnAlloc and
- // pfnFree must be used for doing the allocation.
- //
- // ContentEncryptionAlgorithm.pszObjId is used to get the OIDFunctionAddress.
- //--------------------------------------------------------------------------
- #define CMSG_OID_GEN_CONTENT_ENCRYPT_KEY_FUNC "CryptMsgDllGenContentEncryptKey"
- typedef BOOL (WINAPI *PFN_CMSG_GEN_CONTENT_ENCRYPT_KEY) (
- IN OUT PCMSG_CONTENT_ENCRYPT_INFO pContentEncryptInfo,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // Key Transport Encrypt Info
- //
- // The following data structure contains the information updated by the
- // ExportKeyTrans installable function.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_KEY_TRANS_ENCRYPT_INFO {
- DWORD cbSize;
- DWORD dwRecipientIndex;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- CRYPT_DATA_BLOB EncryptedKey;
- DWORD dwFlags;
- } CMSG_KEY_TRANS_ENCRYPT_INFO, *PCMSG_KEY_TRANS_ENCRYPT_INFO;
- #define CMSG_KEY_TRANS_ENCRYPT_FREE_PARA_FLAG 0x00000001
- //+-------------------------------------------------------------------------
- // Upon input, KeyTransEncryptInfo has been initialized from the
- // KeyTransEncodeInfo.
- //
- // The following fields may be changed in KeyTransEncryptInfo:
- // EncryptedKey
- // KeyEncryptionAlgorithm.Parameters
- // dwFlags
- //
- // All other fields in the KeyTransEncryptInfo are READONLY.
- //
- // The EncryptedKey must be updated. The pfnAlloc and pfnFree specified in
- // ContentEncryptInfo must be used for doing the allocation.
- //
- // If the KeyEncryptionAlgorithm.Parameters is updated, then, the
- // CMSG_KEY_TRANS_ENCRYPT_FREE_PARA_FLAG must be set in dwFlags.
- // The pfnAlloc and pfnFree specified in ContentEncryptInfo must be used
- // for doing the allocation.
- //
- // KeyEncryptionAlgorithm.pszObjId is used to get the OIDFunctionAddress.
- //--------------------------------------------------------------------------
- #define CMSG_OID_EXPORT_KEY_TRANS_FUNC "CryptMsgDllExportKeyTrans"
- typedef BOOL (WINAPI *PFN_CMSG_EXPORT_KEY_TRANS) (
- IN PCMSG_CONTENT_ENCRYPT_INFO pContentEncryptInfo,
- IN PCMSG_KEY_TRANS_RECIPIENT_ENCODE_INFO pKeyTransEncodeInfo,
- IN OUT PCMSG_KEY_TRANS_ENCRYPT_INFO pKeyTransEncryptInfo,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // Key Agree Key Encrypt Info
- //
- // The following data structure contains the information updated by the
- // ExportKeyAgree installable function for each encrypted key agree
- // recipient.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_KEY_AGREE_KEY_ENCRYPT_INFO {
- DWORD cbSize;
- CRYPT_DATA_BLOB EncryptedKey;
- } CMSG_KEY_AGREE_KEY_ENCRYPT_INFO, *PCMSG_KEY_AGREE_KEY_ENCRYPT_INFO;
- //+-------------------------------------------------------------------------
- // Key Agree Encrypt Info
- //
- // The following data structure contains the information applicable to
- // all recipients. Its updated by the ExportKeyAgree installable function.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_KEY_AGREE_ENCRYPT_INFO {
- DWORD cbSize;
- DWORD dwRecipientIndex;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- CRYPT_DATA_BLOB UserKeyingMaterial;
- DWORD dwOriginatorChoice;
- union {
- // CMSG_KEY_AGREE_ORIGINATOR_CERT
- CERT_ID OriginatorCertId;
- // CMSG_KEY_AGREE_ORIGINATOR_PUBLIC_KEY
- CERT_PUBLIC_KEY_INFO OriginatorPublicKeyInfo;
- };
- DWORD cKeyAgreeKeyEncryptInfo;
- PCMSG_KEY_AGREE_KEY_ENCRYPT_INFO *rgpKeyAgreeKeyEncryptInfo;
- DWORD dwFlags;
- } CMSG_KEY_AGREE_ENCRYPT_INFO, *PCMSG_KEY_AGREE_ENCRYPT_INFO;
- #define CMSG_KEY_AGREE_ENCRYPT_FREE_PARA_FLAG 0x00000001
- #define CMSG_KEY_AGREE_ENCRYPT_FREE_MATERIAL_FLAG 0x00000002
- #define CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_ALG_FLAG 0x00000004
- #define CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_PARA_FLAG 0x00000008
- #define CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_BITS_FLAG 0x00000010
- //+-------------------------------------------------------------------------
- // Upon input, KeyAgreeEncryptInfo has been initialized from the
- // KeyAgreeEncodeInfo.
- //
- // The following fields may be changed in KeyAgreeEncryptInfo:
- // KeyEncryptionAlgorithm.Parameters
- // UserKeyingMaterial
- // dwOriginatorChoice
- // OriginatorCertId
- // OriginatorPublicKeyInfo
- // dwFlags
- //
- // All other fields in the KeyAgreeEncryptInfo are READONLY.
- //
- // If the KeyEncryptionAlgorithm.Parameters is updated, then, the
- // CMSG_KEY_AGREE_ENCRYPT_FREE_PARA_FLAG must be set in dwFlags.
- // The pfnAlloc and pfnFree specified in ContentEncryptInfo must be used
- // for doing the allocation.
- //
- // If the UserKeyingMaterial is updated, then, the
- // CMSG_KEY_AGREE_ENCRYPT_FREE_MATERIAL_FLAG must be set in dwFlags.
- // pfnAlloc and pfnFree must be used for doing the allocation.
- //
- // The dwOriginatorChoice must be updated to either
- // CMSG_KEY_AGREE_ORIGINATOR_CERT or CMSG_KEY_AGREE_ORIGINATOR_PUBLIC_KEY.
- //
- // If the OriginatorPublicKeyInfo is updated, then, the appropriate
- // CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_*_FLAG must be set in dwFlags and
- // pfnAlloc and pfnFree must be used for doing the allocation.
- //
- // If CMSG_CONTENT_ENCRYPT_PAD_ENCODED_LEN_FLAG is set upon entry
- // in pContentEncryptInfo->dwEncryptFlags, then, the OriginatorPublicKeyInfo's
- // Ephemeral PublicKey should be padded with zeroes to always obtain the
- // same maximum encoded length. Note, the length of the generated ephemeral Y
- // public key can vary depending on the number of leading zero bits.
- //
- // Upon input, the array of *rgpKeyAgreeKeyEncryptInfo has been initialized.
- // The EncryptedKey must be updated for each recipient key.
- // The pfnAlloc and pfnFree specified in
- // ContentEncryptInfo must be used for doing the allocation.
- //
- // KeyEncryptionAlgorithm.pszObjId is used to get the OIDFunctionAddress.
- //--------------------------------------------------------------------------
- #define CMSG_OID_EXPORT_KEY_AGREE_FUNC "CryptMsgDllExportKeyAgree"
- typedef BOOL (WINAPI *PFN_CMSG_EXPORT_KEY_AGREE) (
- IN PCMSG_CONTENT_ENCRYPT_INFO pContentEncryptInfo,
- IN PCMSG_KEY_AGREE_RECIPIENT_ENCODE_INFO pKeyAgreeEncodeInfo,
- IN OUT PCMSG_KEY_AGREE_ENCRYPT_INFO pKeyAgreeEncryptInfo,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // Mail List Encrypt Info
- //
- // The following data structure contains the information updated by the
- // ExportMailList installable function.
- //--------------------------------------------------------------------------
- typedef struct _CMSG_MAIL_LIST_ENCRYPT_INFO {
- DWORD cbSize;
- DWORD dwRecipientIndex;
- CRYPT_ALGORITHM_IDENTIFIER KeyEncryptionAlgorithm;
- CRYPT_DATA_BLOB EncryptedKey;
- DWORD dwFlags;
- } CMSG_MAIL_LIST_ENCRYPT_INFO, *PCMSG_MAIL_LIST_ENCRYPT_INFO;
- #define CMSG_MAIL_LIST_ENCRYPT_FREE_PARA_FLAG 0x00000001
- //+-------------------------------------------------------------------------
- // Upon input, MailListEncryptInfo has been initialized from the
- // MailListEncodeInfo.
- //
- // The following fields may be changed in MailListEncryptInfo:
- // EncryptedKey
- // KeyEncryptionAlgorithm.Parameters
- // dwFlags
- //
- // All other fields in the MailListEncryptInfo are READONLY.
- //
- // The EncryptedKey must be updated. The pfnAlloc and pfnFree specified in
- // ContentEncryptInfo must be used for doing the allocation.
- //
- // If the KeyEncryptionAlgorithm.Parameters is updated, then, the
- // CMSG_MAIL_LIST_ENCRYPT_FREE_PARA_FLAG must be set in dwFlags.
- // The pfnAlloc and pfnFree specified in ContentEncryptInfo must be used
- // for doing the allocation.
- //
- // KeyEncryptionAlgorithm.pszObjId is used to get the OIDFunctionAddress.
- //--------------------------------------------------------------------------
- #define CMSG_OID_EXPORT_MAIL_LIST_FUNC "CryptMsgDllExportMailList"
- typedef BOOL (WINAPI *PFN_CMSG_EXPORT_MAIL_LIST) (
- IN PCMSG_CONTENT_ENCRYPT_INFO pContentEncryptInfo,
- IN PCMSG_MAIL_LIST_RECIPIENT_ENCODE_INFO pMailListEncodeInfo,
- IN OUT PCMSG_MAIL_LIST_ENCRYPT_INFO pMailListEncryptInfo,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // OID Installable functions for importing an encoded and encrypted content
- // encryption key.
- //
- // There's a different installable function for each CMS Recipient choice:
- // ImportKeyTrans
- // ImportKeyAgree
- // ImportMailList
- //
- // Iterates through the following OIDs to get the OID installable function:
- // KeyEncryptionOID!ContentEncryptionOID
- // KeyEncryptionOID
- // ContentEncryptionOID
- //
- // If the OID installable function doesn't support the specified
- // KeyEncryption and ContentEncryption OIDs, then, return FALSE with
- // LastError set to E_NOTIMPL.
- //--------------------------------------------------------------------------
- #define CMSG_OID_IMPORT_KEY_TRANS_FUNC "CryptMsgDllImportKeyTrans"
- typedef BOOL (WINAPI *PFN_CMSG_IMPORT_KEY_TRANS) (
- IN PCRYPT_ALGORITHM_IDENTIFIER pContentEncryptionAlgorithm,
- IN PCMSG_CTRL_KEY_TRANS_DECRYPT_PARA pKeyTransDecryptPara,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved,
- OUT HCRYPTKEY *phContentEncryptKey
- );
- #define CMSG_OID_IMPORT_KEY_AGREE_FUNC "CryptMsgDllImportKeyAgree"
- typedef BOOL (WINAPI *PFN_CMSG_IMPORT_KEY_AGREE) (
- IN PCRYPT_ALGORITHM_IDENTIFIER pContentEncryptionAlgorithm,
- IN PCMSG_CTRL_KEY_AGREE_DECRYPT_PARA pKeyAgreeDecryptPara,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved,
- OUT HCRYPTKEY *phContentEncryptKey
- );
- #define CMSG_OID_IMPORT_MAIL_LIST_FUNC "CryptMsgDllImportMailList"
- typedef BOOL (WINAPI *PFN_CMSG_IMPORT_MAIL_LIST) (
- IN PCRYPT_ALGORITHM_IDENTIFIER pContentEncryptionAlgorithm,
- IN PCMSG_CTRL_MAIL_LIST_DECRYPT_PARA pMailListDecryptPara,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved,
- OUT HCRYPTKEY *phContentEncryptKey
- );
- //+=========================================================================
- // Certificate Store Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // In its most basic implementation, a cert store is simply a
- // collection of certificates and/or CRLs. This is the case when
- // a cert store is opened with all of its certificates and CRLs
- // coming from a PKCS #7 encoded cryptographic message.
- //
- // Nonetheless, all cert stores have the following properties:
- // - A public key may have more than one certificate in the store.
- // For example, a private/public key used for signing may have a
- // certificate issued for VISA and another issued for
- // Mastercard. Also, when a certificate is renewed there might
- // be more than one certificate with the same subject and
- // issuer.
- // - However, each certificate in the store is uniquely
- // identified by its Issuer and SerialNumber.
- // - There's an issuer of subject certificate relationship. A
- // certificate's issuer is found by doing a match of
- // pSubjectCert->Issuer with pIssuerCert->Subject.
- // The relationship is verified by using
- // the issuer's public key to verify the subject certificate's
- // signature. Note, there might be X.509 v3 extensions
- // to assist in finding the issuer certificate.
- // - Since issuer certificates might be renewed, a subject
- // certificate might have more than one issuer certificate.
- // - There's an issuer of CRL relationship. An
- // issuer's CRL is found by doing a match of
- // pIssuerCert->Subject with pCrl->Issuer.
- // The relationship is verified by using
- // the issuer's public key to verify the CRL's
- // signature. Note, there might be X.509 v3 extensions
- // to assist in finding the CRL.
- // - Since some issuers might support the X.509 v3 delta CRL
- // extensions, an issuer might have more than one CRL.
- // - The store shouldn't have any redundant certificates or
- // CRLs. There shouldn't be two certificates with the same
- // Issuer and SerialNumber. There shouldn't be two CRLs with
- // the same Issuer, ThisUpdate and NextUpdate.
- // - The store has NO policy or trust information. No
- // certificates are tagged as being "root". Its up to
- // the application to maintain a list of CertIds (Issuer +
- // SerialNumber) for certificates it trusts.
- // - The store might contain bad certificates and/or CRLs.
- // The issuer's signature of a subject certificate or CRL may
- // not verify. Certificates or CRLs may not satisfy their
- // time validity requirements. Certificates may be
- // revoked.
- //
- // In addition to the certificates and CRLs, properties can be
- // stored. There are two predefined property IDs for a user
- // certificate: CERT_KEY_PROV_HANDLE_PROP_ID and
- // CERT_KEY_PROV_INFO_PROP_ID. The CERT_KEY_PROV_HANDLE_PROP_ID
- // is a HCRYPTPROV handle to the private key assoicated
- // with the certificate. The CERT_KEY_PROV_INFO_PROP_ID contains
- // information to be used to call
- // CryptAcquireContext and CryptSetProvParam to get a handle
- // to the private key associated with the certificate.
- //
- // There exists two more predefined property IDs for certificates
- // and CRLs, CERT_SHA1_HASH_PROP_ID and CERT_MD5_HASH_PROP_ID.
- // If these properties don't already exist, then, a hash of the
- // content is computed. (CERT_HASH_PROP_ID maps to the default
- // hash algorithm, currently, CERT_SHA1_HASH_PROP_ID).
- //
- // There are additional APIs for creating certificate and CRL
- // contexts not in a store (CertCreateCertificateContext and
- // CertCreateCRLContext).
- //
- //--------------------------------------------------------------------------
- typedef void *HCERTSTORE;
- //+-------------------------------------------------------------------------
- // Certificate context.
- //
- // A certificate context contains both the encoded and decoded representation
- // of a certificate. A certificate context returned by a cert store function
- // must be freed by calling the CertFreeCertificateContext function. The
- // CertDuplicateCertificateContext function can be called to make a duplicate
- // copy (which also must be freed by calling CertFreeCertificateContext).
- //--------------------------------------------------------------------------
- typedef struct _CERT_CONTEXT {
- DWORD dwCertEncodingType;
- BYTE *pbCertEncoded;
- DWORD cbCertEncoded;
- PCERT_INFO pCertInfo;
- HCERTSTORE hCertStore;
- } CERT_CONTEXT, *PCERT_CONTEXT;
- typedef const CERT_CONTEXT *PCCERT_CONTEXT;
- //+-------------------------------------------------------------------------
- // CRL context.
- //
- // A CRL context contains both the encoded and decoded representation
- // of a CRL. A CRL context returned by a cert store function
- // must be freed by calling the CertFreeCRLContext function. The
- // CertDuplicateCRLContext function can be called to make a duplicate
- // copy (which also must be freed by calling CertFreeCRLContext).
- //--------------------------------------------------------------------------
- typedef struct _CRL_CONTEXT {
- DWORD dwCertEncodingType;
- BYTE *pbCrlEncoded;
- DWORD cbCrlEncoded;
- PCRL_INFO pCrlInfo;
- HCERTSTORE hCertStore;
- } CRL_CONTEXT, *PCRL_CONTEXT;
- typedef const CRL_CONTEXT *PCCRL_CONTEXT;
- //+-------------------------------------------------------------------------
- // Certificate Trust List (CTL) context.
- //
- // A CTL context contains both the encoded and decoded representation
- // of a CTL. Also contains an opened HCRYPTMSG handle to the decoded
- // cryptographic signed message containing the CTL_INFO as its inner content.
- // pbCtlContent is the encoded inner content of the signed message.
- //
- // The CryptMsg APIs can be used to extract additional signer information.
- //--------------------------------------------------------------------------
- typedef struct _CTL_CONTEXT {
- DWORD dwMsgAndCertEncodingType;
- BYTE *pbCtlEncoded;
- DWORD cbCtlEncoded;
- PCTL_INFO pCtlInfo;
- HCERTSTORE hCertStore;
- HCRYPTMSG hCryptMsg;
- BYTE *pbCtlContent;
- DWORD cbCtlContent;
- } CTL_CONTEXT, *PCTL_CONTEXT;
- typedef const CTL_CONTEXT *PCCTL_CONTEXT;
- //+-------------------------------------------------------------------------
- // Certificate, CRL and CTL property IDs
- //
- // See CertSetCertificateContextProperty or CertGetCertificateContextProperty
- // for usage information.
- //--------------------------------------------------------------------------
- #define CERT_KEY_PROV_HANDLE_PROP_ID 1
- #define CERT_KEY_PROV_INFO_PROP_ID 2
- #define CERT_SHA1_HASH_PROP_ID 3
- #define CERT_MD5_HASH_PROP_ID 4
- #define CERT_HASH_PROP_ID CERT_SHA1_HASH_PROP_ID
- #define CERT_KEY_CONTEXT_PROP_ID 5
- #define CERT_KEY_SPEC_PROP_ID 6
- #define CERT_IE30_RESERVED_PROP_ID 7
- #define CERT_PUBKEY_HASH_RESERVED_PROP_ID 8
- #define CERT_ENHKEY_USAGE_PROP_ID 9
- #define CERT_CTL_USAGE_PROP_ID CERT_ENHKEY_USAGE_PROP_ID
- #define CERT_NEXT_UPDATE_LOCATION_PROP_ID 10
- #define CERT_FRIENDLY_NAME_PROP_ID 11
- #define CERT_PVK_FILE_PROP_ID 12
- #define CERT_DESCRIPTION_PROP_ID 13
- #define CERT_ACCESS_STATE_PROP_ID 14
- #define CERT_SIGNATURE_HASH_PROP_ID 15
- #define CERT_SMART_CARD_DATA_PROP_ID 16
- #define CERT_EFS_PROP_ID 17
- #define CERT_FORTEZZA_DATA_PROP_ID 18
- #define CERT_ARCHIVED_PROP_ID 19
- #define CERT_KEY_IDENTIFIER_PROP_ID 20
- #define CERT_AUTO_ENROLL_PROP_ID 21
- #define CERT_PUBKEY_ALG_PARA_PROP_ID 22
- #define CERT_CROSS_CERT_DIST_POINTS_PROP_ID 23
- #define CERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_ID 24
- #define CERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_ID 25
- #define CERT_ENROLLMENT_PROP_ID 26
- #define CERT_DATE_STAMP_PROP_ID 27
- #define CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID 28
- #define CERT_SUBJECT_NAME_MD5_HASH_PROP_ID 29
- #define CERT_EXTENDED_ERROR_INFO_PROP_ID 30
- // Note, 32 - 35 are reserved for the CERT, CRL, CTL and KeyId file element IDs.
- // 36 - 63 are reserved for future element IDs.
- #define CERT_RENEWAL_PROP_ID 64
- #define CERT_ARCHIVED_KEY_HASH_PROP_ID 65
- #define CERT_AUTO_ENROLL_RETRY_PROP_ID 66
- #define CERT_AIA_URL_RETRIEVED_PROP_ID 67
- #define CERT_FIRST_RESERVED_PROP_ID 68
- #define CERT_LAST_RESERVED_PROP_ID 0x00007FFF
- #define CERT_FIRST_USER_PROP_ID 0x00008000
- #define CERT_LAST_USER_PROP_ID 0x0000FFFF
- #define IS_CERT_HASH_PROP_ID(X) (CERT_SHA1_HASH_PROP_ID == (X) || \
- CERT_MD5_HASH_PROP_ID == (X) || \
- CERT_SIGNATURE_HASH_PROP_ID == (X))
- #define IS_PUBKEY_HASH_PROP_ID(X) (CERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_ID == (X) || \
- CERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_ID == (X))
- #define IS_CHAIN_HASH_PROP_ID(X) (CERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_ID == (X) || \
- CERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_ID == (X) || \
- CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID == (X) || \
- CERT_SUBJECT_NAME_MD5_HASH_PROP_ID == (X))
- //+-------------------------------------------------------------------------
- // Property OIDs
- //--------------------------------------------------------------------------
- // The OID component following the prefix contains the PROP_ID (decimal)
- #define szOID_CERT_PROP_ID_PREFIX "1.3.6.1.4.1.311.10.11."
- #define szOID_CERT_KEY_IDENTIFIER_PROP_ID "1.3.6.1.4.1.311.10.11.20"
- #define szOID_CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID \
- "1.3.6.1.4.1.311.10.11.28"
- #define szOID_CERT_SUBJECT_NAME_MD5_HASH_PROP_ID \
- "1.3.6.1.4.1.311.10.11.29"
- //+-------------------------------------------------------------------------
- // Access State flags returned by CERT_ACCESS_STATE_PROP_ID. Note,
- // CERT_ACCESS_PROP_ID is read only.
- //--------------------------------------------------------------------------
- // Set if context property writes are persisted. For instance, not set for
- // memory store contexts. Set for registry based stores opened as read or write.
- // Not set for registry based stores opened as read only.
- #define CERT_ACCESS_STATE_WRITE_PERSIST_FLAG 0x1
- // Set if context resides in a SYSTEM or SYSTEM_REGISTRY store.
- #define CERT_ACCESS_STATE_SYSTEM_STORE_FLAG 0x2
- // Set if context resides in a LocalMachine SYSTEM or SYSTEM_REGISTRY store.
- #define CERT_ACCESS_STATE_LM_SYSTEM_STORE_FLAG 0x4
- //+-------------------------------------------------------------------------
- // Cryptographic Key Provider Information
- //
- // CRYPT_KEY_PROV_INFO defines the CERT_KEY_PROV_INFO_PROP_ID's pvData.
- //
- // The CRYPT_KEY_PROV_INFO fields are passed to CryptAcquireContext
- // to get a HCRYPTPROV handle. The optional CRYPT_KEY_PROV_PARAM fields are
- // passed to CryptSetProvParam to further initialize the provider.
- //
- // The dwKeySpec field identifies the private key to use from the container
- // For example, AT_KEYEXCHANGE or AT_SIGNATURE.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_KEY_PROV_PARAM {
- DWORD dwParam;
- BYTE *pbData;
- DWORD cbData;
- DWORD dwFlags;
- } CRYPT_KEY_PROV_PARAM, *PCRYPT_KEY_PROV_PARAM;
- typedef struct _CRYPT_KEY_PROV_INFO {
- LPWSTR pwszContainerName;
- LPWSTR pwszProvName;
- DWORD dwProvType;
- DWORD dwFlags;
- DWORD cProvParam;
- PCRYPT_KEY_PROV_PARAM rgProvParam;
- DWORD dwKeySpec;
- } CRYPT_KEY_PROV_INFO, *PCRYPT_KEY_PROV_INFO;
- //+-------------------------------------------------------------------------
- // The following flag should be set in the above dwFlags to enable
- // a CertSetCertificateContextProperty(CERT_KEY_CONTEXT_PROP_ID) after a
- // CryptAcquireContext is done in the Sign or Decrypt Message functions.
- //
- // The following define must not collide with any of the
- // CryptAcquireContext dwFlag defines.
- //--------------------------------------------------------------------------
- #define CERT_SET_KEY_PROV_HANDLE_PROP_ID 0x00000001
- #define CERT_SET_KEY_CONTEXT_PROP_ID 0x00000001
- //+-------------------------------------------------------------------------
- // Certificate Key Context
- //
- // CERT_KEY_CONTEXT defines the CERT_KEY_CONTEXT_PROP_ID's pvData.
- //--------------------------------------------------------------------------
- typedef struct _CERT_KEY_CONTEXT {
- DWORD cbSize; // sizeof(CERT_KEY_CONTEXT)
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- } CERT_KEY_CONTEXT, *PCERT_KEY_CONTEXT;
- //+-------------------------------------------------------------------------
- // Certificate Store Provider Types
- //--------------------------------------------------------------------------
- #define CERT_STORE_PROV_MSG ((LPCSTR) 1)
- #define CERT_STORE_PROV_MEMORY ((LPCSTR) 2)
- #define CERT_STORE_PROV_FILE ((LPCSTR) 3)
- #define CERT_STORE_PROV_REG ((LPCSTR) 4)
- #define CERT_STORE_PROV_PKCS7 ((LPCSTR) 5)
- #define CERT_STORE_PROV_SERIALIZED ((LPCSTR) 6)
- #define CERT_STORE_PROV_FILENAME_A ((LPCSTR) 7)
- #define CERT_STORE_PROV_FILENAME_W ((LPCSTR) 8)
- #define CERT_STORE_PROV_FILENAME CERT_STORE_PROV_FILENAME_W
- #define CERT_STORE_PROV_SYSTEM_A ((LPCSTR) 9)
- #define CERT_STORE_PROV_SYSTEM_W ((LPCSTR) 10)
- #define CERT_STORE_PROV_SYSTEM CERT_STORE_PROV_SYSTEM_W
- #define CERT_STORE_PROV_COLLECTION ((LPCSTR) 11)
- #define CERT_STORE_PROV_SYSTEM_REGISTRY_A ((LPCSTR) 12)
- #define CERT_STORE_PROV_SYSTEM_REGISTRY_W ((LPCSTR) 13)
- #define CERT_STORE_PROV_SYSTEM_REGISTRY CERT_STORE_PROV_SYSTEM_REGISTRY_W
- #define CERT_STORE_PROV_PHYSICAL_W ((LPCSTR) 14)
- #define CERT_STORE_PROV_PHYSICAL CERT_STORE_PROV_PHYSICAL_W
- #define CERT_STORE_PROV_SMART_CARD_W ((LPCSTR) 15)
- #define CERT_STORE_PROV_SMART_CARD CERT_STORE_PROV_SMART_CARD_W
- #define CERT_STORE_PROV_LDAP_W ((LPCSTR) 16)
- #define CERT_STORE_PROV_LDAP CERT_STORE_PROV_LDAP_W
- #define sz_CERT_STORE_PROV_MEMORY "Memory"
- #define sz_CERT_STORE_PROV_FILENAME_W "File"
- #define sz_CERT_STORE_PROV_FILENAME sz_CERT_STORE_PROV_FILENAME_W
- #define sz_CERT_STORE_PROV_SYSTEM_W "System"
- #define sz_CERT_STORE_PROV_SYSTEM sz_CERT_STORE_PROV_SYSTEM_W
- #define sz_CERT_STORE_PROV_PKCS7 "PKCS7"
- #define sz_CERT_STORE_PROV_SERIALIZED "Serialized"
- #define sz_CERT_STORE_PROV_COLLECTION "Collection"
- #define sz_CERT_STORE_PROV_SYSTEM_REGISTRY_W "SystemRegistry"
- #define sz_CERT_STORE_PROV_SYSTEM_REGISTRY sz_CERT_STORE_PROV_SYSTEM_REGISTRY_W
- #define sz_CERT_STORE_PROV_PHYSICAL_W "Physical"
- #define sz_CERT_STORE_PROV_PHYSICAL sz_CERT_STORE_PROV_PHYSICAL_W
- #define sz_CERT_STORE_PROV_SMART_CARD_W "SmartCard"
- #define sz_CERT_STORE_PROV_SMART_CARD sz_CERT_STORE_PROV_SMART_CARD_W
- #define sz_CERT_STORE_PROV_LDAP_W "Ldap"
- #define sz_CERT_STORE_PROV_LDAP sz_CERT_STORE_PROV_LDAP_W
- //+-------------------------------------------------------------------------
- // Certificate Store verify/results flags
- //--------------------------------------------------------------------------
- #define CERT_STORE_SIGNATURE_FLAG 0x00000001
- #define CERT_STORE_TIME_VALIDITY_FLAG 0x00000002
- #define CERT_STORE_REVOCATION_FLAG 0x00000004
- #define CERT_STORE_NO_CRL_FLAG 0x00010000
- #define CERT_STORE_NO_ISSUER_FLAG 0x00020000
- #define CERT_STORE_BASE_CRL_FLAG 0x00000100
- #define CERT_STORE_DELTA_CRL_FLAG 0x00000200
- //+-------------------------------------------------------------------------
- // Certificate Store open/property flags
- //--------------------------------------------------------------------------
- #define CERT_STORE_NO_CRYPT_RELEASE_FLAG 0x00000001
- #define CERT_STORE_SET_LOCALIZED_NAME_FLAG 0x00000002
- #define CERT_STORE_DEFER_CLOSE_UNTIL_LAST_FREE_FLAG 0x00000004
- #define CERT_STORE_DELETE_FLAG 0x00000010
- #define CERT_STORE_UNSAFE_PHYSICAL_FLAG 0x00000020
- #define CERT_STORE_SHARE_STORE_FLAG 0x00000040
- #define CERT_STORE_SHARE_CONTEXT_FLAG 0x00000080
- #define CERT_STORE_MANIFOLD_FLAG 0x00000100
- #define CERT_STORE_ENUM_ARCHIVED_FLAG 0x00000200
- #define CERT_STORE_UPDATE_KEYID_FLAG 0x00000400
- #define CERT_STORE_BACKUP_RESTORE_FLAG 0x00000800
- #define CERT_STORE_READONLY_FLAG 0x00008000
- #define CERT_STORE_OPEN_EXISTING_FLAG 0x00004000
- #define CERT_STORE_CREATE_NEW_FLAG 0x00002000
- #define CERT_STORE_MAXIMUM_ALLOWED_FLAG 0x00001000
- //+-------------------------------------------------------------------------
- // Certificate Store Provider flags are in the HiWord (0xFFFF0000)
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Certificate System Store Flag Values
- //--------------------------------------------------------------------------
- // Includes flags and location
- #define CERT_SYSTEM_STORE_MASK 0xFFFF0000
- // Set if pvPara points to a CERT_SYSTEM_STORE_RELOCATE_PARA structure
- #define CERT_SYSTEM_STORE_RELOCATE_FLAG 0x80000000
- typedef struct _CERT_SYSTEM_STORE_RELOCATE_PARA {
- union {
- HKEY hKeyBase;
- void *pvBase;
- };
- union {
- void *pvSystemStore;
- LPCSTR pszSystemStore;
- LPCWSTR pwszSystemStore;
- };
- } CERT_SYSTEM_STORE_RELOCATE_PARA, *PCERT_SYSTEM_STORE_RELOCATE_PARA;
- // By default, when the CurrentUser "Root" store is opened, any SystemRegistry
- // roots not also on the protected root list are deleted from the cache before
- // CertOpenStore() returns. Set the following flag to return all the roots
- // in the SystemRegistry without checking the protected root list.
- #define CERT_SYSTEM_STORE_UNPROTECTED_FLAG 0x40000000
- // Location of the system store:
- #define CERT_SYSTEM_STORE_LOCATION_MASK 0x00FF0000
- #define CERT_SYSTEM_STORE_LOCATION_SHIFT 16
- // Registry: HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE
- #define CERT_SYSTEM_STORE_CURRENT_USER_ID 1
- #define CERT_SYSTEM_STORE_LOCAL_MACHINE_ID 2
- // Registry: HKEY_LOCAL_MACHINE\Software\Microsoft\Cryptography\Services
- #define CERT_SYSTEM_STORE_CURRENT_SERVICE_ID 4
- #define CERT_SYSTEM_STORE_SERVICES_ID 5
- // Registry: HKEY_USERS
- #define CERT_SYSTEM_STORE_USERS_ID 6
- // Registry: HKEY_CURRENT_USER\Software\Policies\Microsoft\SystemCertificates
- #define CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID 7
- // Registry: HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\SystemCertificates
- #define CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID 8
- // Registry: HKEY_LOCAL_MACHINE\Software\Microsoft\EnterpriseCertificates
- #define CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID 9
- #define CERT_SYSTEM_STORE_CURRENT_USER \
- (CERT_SYSTEM_STORE_CURRENT_USER_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT)
- #define CERT_SYSTEM_STORE_LOCAL_MACHINE \
- (CERT_SYSTEM_STORE_LOCAL_MACHINE_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT)
- #define CERT_SYSTEM_STORE_CURRENT_SERVICE \
- (CERT_SYSTEM_STORE_CURRENT_SERVICE_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT)
- #define CERT_SYSTEM_STORE_SERVICES \
- (CERT_SYSTEM_STORE_SERVICES_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT)
- #define CERT_SYSTEM_STORE_USERS \
- (CERT_SYSTEM_STORE_USERS_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT)
- #define CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY \
- (CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID << \
- CERT_SYSTEM_STORE_LOCATION_SHIFT)
- #define CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY \
- (CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID << \
- CERT_SYSTEM_STORE_LOCATION_SHIFT)
- #define CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE \
- (CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID << \
- CERT_SYSTEM_STORE_LOCATION_SHIFT)
- //+-------------------------------------------------------------------------
- // Group Policy Store Defines
- //--------------------------------------------------------------------------
- // Registry path to the Group Policy system stores
- #define CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH \
- L"Software\\Policies\\Microsoft\\SystemCertificates"
- //+-------------------------------------------------------------------------
- // EFS Defines
- //--------------------------------------------------------------------------
- // Registry path to the EFS EFSBlob SubKey - Value type is REG_BINARY
- #define CERT_EFSBLOB_REGPATH \
- CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH L"\\EFS"
- #define CERT_EFSBLOB_VALUE_NAME L"EFSBlob"
- //+-------------------------------------------------------------------------
- // Protected Root Defines
- //--------------------------------------------------------------------------
- // Registry path to the Protected Roots Flags SubKey
- #define CERT_PROT_ROOT_FLAGS_REGPATH \
- CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH L"\\Root\\ProtectedRoots"
- #define CERT_PROT_ROOT_FLAGS_VALUE_NAME L"Flags"
- // Set the following flag to inhibit the opening of the CurrentUser's
- // .Default physical store when opening the CurrentUser's "Root" system store.
- // The .Default physical store open's the CurrentUser SystemRegistry "Root"
- // store.
- #define CERT_PROT_ROOT_DISABLE_CURRENT_USER_FLAG 0x1
- // Set the following flag to inhibit the adding of roots from the
- // CurrentUser SystemRegistry "Root" store to the protected root list
- // when the "Root" store is initially protected.
- #define CERT_PROT_ROOT_INHIBIT_ADD_AT_INIT_FLAG 0x2
- // Set the following flag to inhibit the purging of protected roots from the
- // CurrentUser SystemRegistry "Root" store that are
- // also in the LocalMachine SystemRegistry "Root" store. Note, when not
- // disabled, the purging is done silently without UI.
- #define CERT_PROT_ROOT_INHIBIT_PURGE_LM_FLAG 0x4
- // Set the following flag to inhibit the opening of the LocalMachine's
- // .AuthRoot physical store when opening the LocalMachine's "Root" system store.
- // The .AuthRoot physical store open's the LocalMachine SystemRegistry
- // "AuthRoot" store. The "AuthRoot" store contains the pre-installed
- // SSL ServerAuth and the ActiveX Authenticode "root" certificates.
- #define CERT_PROT_ROOT_DISABLE_LM_AUTH_FLAG 0x8
- // The semantics for the following legacy definition has been changed to be
- // the same as for the CERT_PROT_ROOT_DISABLE_LM_AUTH_FLAG.
- #define CERT_PROT_ROOT_ONLY_LM_GPT_FLAG 0x8
- // Set the following flag to disable the requiring of the issuing CA
- // certificate being in the "NTAuth" system registry store found in the
- // CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE store location.
- //
- // When set, CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_NT_AUTH)
- // will check that the chain has a valid name constraint for all name
- // spaces, including UPN if the issuing CA isn't in the "NTAuth" store.
- #define CERT_PROT_ROOT_DISABLE_NT_AUTH_REQUIRED_FLAG 0x10
- // Set the following flag to disable checking for not defined name
- // constraints.
- //
- // When set, CertGetCertificateChain won't check for or set the following
- // dwErrorStatus: CERT_TRUST_HAS_NOT_DEFINED_NAME_CONSTRAINT.
- #define CERT_PROT_ROOT_DISABLE_NOT_DEFINED_NAME_CONSTRAINT_FLAG 0x20
- //+-------------------------------------------------------------------------
- // Trusted Publisher Definitions
- //--------------------------------------------------------------------------
- // Registry path to the trusted publisher "Safer" group policy subkey
- #define CERT_TRUST_PUB_SAFER_GROUP_POLICY_REGPATH \
- CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH L"\\TrustedPublisher\\Safer"
- // Registry path to the Local Machine system stores
- #define CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH \
- L"Software\\Microsoft\\SystemCertificates"
- // Registry path to the trusted publisher "Safer" local machine subkey
- #define CERT_TRUST_PUB_SAFER_LOCAL_MACHINE_REGPATH \
- CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH L"\\TrustedPublisher\\Safer"
- // "Safer" subkey value names. All values are DWORDs.
- #define CERT_TRUST_PUB_AUTHENTICODE_FLAGS_VALUE_NAME L"AuthenticodeFlags"
- // AuthenticodeFlags definitions
- // Definition of who is allowed to trust publishers
- //
- // Setting allowed trust to MACHINE_ADMIN or ENTERPRISE_ADMIN disables UI,
- // only trusts publishers in the "TrustedPublisher" system store and
- // inhibits the opening of the CurrentUser's .Default physical store when
- // opening the CurrentUsers's "TrustedPublisher" system store.
- //
- // The .Default physical store open's the CurrentUser SystemRegistry
- // "TrustedPublisher" store.
- //
- // Setting allowed trust to ENTERPRISE_ADMIN only opens the
- // LocalMachine's .GroupPolicy and .Enterprise physical stores when opening
- // the CurrentUser's "TrustedPublisher" system store or when opening the
- // LocalMachine's "TrustedPublisher" system store.
- #define CERT_TRUST_PUB_ALLOW_TRUST_MASK 0x00000003
- #define CERT_TRUST_PUB_ALLOW_END_USER_TRUST 0x00000000
- #define CERT_TRUST_PUB_ALLOW_MACHINE_ADMIN_TRUST 0x00000001
- #define CERT_TRUST_PUB_ALLOW_ENTERPRISE_ADMIN_TRUST 0x00000002
- // Set the following flag to enable revocation checking of the publisher
- // chain.
- #define CERT_TRUST_PUB_CHECK_PUBLISHER_REV_FLAG 0x00000100
- // Set the following flag to enable revocation checking of the time stamp
- // chain.
- #define CERT_TRUST_PUB_CHECK_TIMESTAMP_REV_FLAG 0x00000200
- //+-------------------------------------------------------------------------
- // OCM Subcomponents Definitions
- //--------------------------------------------------------------------------
- // Registry path to the OCM Subcomponents local machine subkey
- #define CERT_OCM_SUBCOMPONENTS_LOCAL_MACHINE_REGPATH \
- L"SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Setup\\OC Manager\\Subcomponents"
- // REG_DWORD, 1 is installed, 0 is NOT installed
- #define CERT_OCM_SUBCOMPONENTS_ROOT_AUTO_UPDATE_VALUE_NAME L"RootAutoUpdate"
-
- //+-------------------------------------------------------------------------
- // AuthRoot Auto Update Definitions
- //--------------------------------------------------------------------------
- // Registry path to the AuthRoot "Auto Update" local machine subkey
- #define CERT_AUTH_ROOT_AUTO_UPDATE_LOCAL_MACHINE_REGPATH \
- CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH L"\\AuthRoot\\AutoUpdate"
- // AuthRoot Auto Update subkey value names.
- // REG_SZ, URL to the directory containing the AuthRoots, CTL and Seq files
- #define CERT_AUTH_ROOT_AUTO_UPDATE_ROOT_DIR_URL_VALUE_NAME L"RootDirUrl"
- // REG_DWORD, seconds between syncs. 0 implies use default.
- #define CERT_AUTH_ROOT_AUTO_UPDATE_SYNC_DELTA_TIME_VALUE_NAME L"SyncDeltaTime"
- // REG_DWORD, misc flags
- #define CERT_AUTH_ROOT_AUTO_UPDATE_FLAGS_VALUE_NAME L"Flags"
- #define CERT_AUTH_ROOT_AUTO_UPDATE_DISABLE_UNTRUSTED_ROOT_LOGGING_FLAG 0x1
- #define CERT_AUTH_ROOT_AUTO_UPDATE_DISABLE_PARTIAL_CHAIN_LOGGING_FLAG 0x2
- // AuthRoot Auto Update filenames
- // CTL containing the list of certs in the AuthRoot store
- #define CERT_AUTH_ROOT_CTL_FILENAME L"authroot.stl"
- #define CERT_AUTH_ROOT_CTL_FILENAME_A "authroot.stl"
- // Cab containing the above CTL
- #define CERT_AUTH_ROOT_CAB_FILENAME L"authrootstl.cab"
- // SequenceNumber (Formatted as big endian ascii hex)
- #define CERT_AUTH_ROOT_SEQ_FILENAME L"authrootseq.txt"
- // Root certs extension
- #define CERT_AUTH_ROOT_CERT_EXT L".crt"
- //+-------------------------------------------------------------------------
- // Certificate Registry Store Flag Values (CERT_STORE_REG)
- //--------------------------------------------------------------------------
- // Set this flag if the HKEY passed in pvPara points to a remote computer
- // registry key.
- #define CERT_REGISTRY_STORE_REMOTE_FLAG 0x10000
- // Set this flag if the contexts are to be persisted as a single serialized
- // store in the registry. Mainly used for stores downloaded from the GPT.
- // Such as the CurrentUserGroupPolicy or LocalMachineGroupPolicy stores.
- #define CERT_REGISTRY_STORE_SERIALIZED_FLAG 0x20000
- // The following flags are for internal use. When set, the
- // pvPara parameter passed to CertOpenStore is a pointer to the following
- // data structure and not the HKEY. The above CERT_REGISTRY_STORE_REMOTE_FLAG
- // is also set if hKeyBase was obtained via RegConnectRegistry().
- #define CERT_REGISTRY_STORE_CLIENT_GPT_FLAG 0x80000000
- #define CERT_REGISTRY_STORE_LM_GPT_FLAG 0x01000000
- typedef struct _CERT_REGISTRY_STORE_CLIENT_GPT_PARA {
- HKEY hKeyBase;
- LPWSTR pwszRegPath;
- } CERT_REGISTRY_STORE_CLIENT_GPT_PARA, *PCERT_REGISTRY_STORE_CLIENT_GPT_PARA;
- // The following flag is for internal use. When set, the contexts are
- // persisted into roaming files instead of the registry. Such as, the
- // CurrentUser "My" store. When this flag is set, the following data structure
- // is passed to CertOpenStore instead of HKEY.
- #define CERT_REGISTRY_STORE_ROAMING_FLAG 0x40000
- // hKey may be NULL or non-NULL. When non-NULL, existing contexts are
- // moved from the registry to roaming files.
- typedef struct _CERT_REGISTRY_STORE_ROAMING_PARA {
- HKEY hKey;
- LPWSTR pwszStoreDirectory;
- } CERT_REGISTRY_STORE_ROAMING_PARA, *PCERT_REGISTRY_STORE_ROAMING_PARA;
- // The following flag is for internal use. When set, the "My" DWORD value
- // at HKLM\Software\Microsoft\Cryptography\IEDirtyFlags is set to 0x1
- // whenever a certificate is added to the registry store.
- //
- // Legacy definition, no longer supported after 01-May-02 (.Net Server)
- #define CERT_REGISTRY_STORE_MY_IE_DIRTY_FLAG 0x80000
- // Registry path to the subkey containing the "My" DWORD value to be set
- //
- // Legacy definition, no longer supported after 01-May-02 (.Net Server)
- #define CERT_IE_DIRTY_FLAGS_REGPATH \
- L"Software\\Microsoft\\Cryptography\\IEDirtyFlags"
- //+-------------------------------------------------------------------------
- // Certificate File Store Flag Values for the providers:
- // CERT_STORE_PROV_FILE
- // CERT_STORE_PROV_FILENAME
- // CERT_STORE_PROV_FILENAME_A
- // CERT_STORE_PROV_FILENAME_W
- // sz_CERT_STORE_PROV_FILENAME_W
- //--------------------------------------------------------------------------
- // Set this flag if any store changes are to be committed to the file.
- // The changes are committed at CertCloseStore or by calling
- // CertControlStore(CERT_STORE_CTRL_COMMIT).
- //
- // The open fails with E_INVALIDARG if both CERT_FILE_STORE_COMMIT_ENABLE_FLAG
- // and CERT_STORE_READONLY_FLAG are set in dwFlags.
- //
- // For the FILENAME providers: if the file contains an X509 encoded
- // certificate, the open fails with ERROR_ACCESS_DENIED.
- //
- // For the FILENAME providers: if CERT_STORE_CREATE_NEW_FLAG is set, the
- // CreateFile uses CREATE_NEW. If CERT_STORE_OPEN_EXISTING is set, uses
- // OPEN_EXISTING. Otherwise, defaults to OPEN_ALWAYS.
- //
- // For the FILENAME providers: the file is committed as either a PKCS7 or
- // serialized store depending on the type read at open. However, if the
- // file is empty then, if the filename has either a ".p7c" or ".spc"
- // extension its committed as a PKCS7. Otherwise, its committed as a
- // serialized store.
- //
- // For CERT_STORE_PROV_FILE, the file handle is duplicated. Its always
- // committed as a serialized store.
- //
- #define CERT_FILE_STORE_COMMIT_ENABLE_FLAG 0x10000
- //+-------------------------------------------------------------------------
- // Certificate LDAP Store Flag Values for the providers:
- // CERT_STORE_PROV_LDAP
- // CERT_STORE_PROV_LDAP_W
- // sz_CERT_STORE_PROV_LDAP_W
- // sz_CERT_STORE_PROV_LDAP
- //--------------------------------------------------------------------------
- // Set this flag to digitally sign all of the ldap traffic to and from a
- // Windows 2000 LDAP server using the Kerberos authentication protocol.
- // This feature provides integrity required by some applications.
- //
- #define CERT_LDAP_STORE_SIGN_FLAG 0x10000
- // Performs an A-Record only DNS lookup on the supplied host string.
- // This prevents bogus DNS queries from being generated when resolving host
- // names. Use this flag whenever passing a hostname as opposed to a
- // domain name for the hostname parameter.
- //
- // See LDAP_OPT_AREC_EXCLUSIVE defined in winldap.h for more details.
- #define CERT_LDAP_STORE_AREC_EXCLUSIVE_FLAG 0x20000
- // Set this flag if the LDAP session handle has already been opened. When
- // set, pvPara points to the following CERT_LDAP_STORE_OPENED_PARA structure.
- #define CERT_LDAP_STORE_OPENED_FLAG 0x40000
- typedef struct _CERT_LDAP_STORE_OPENED_PARA {
- void *pvLdapSessionHandle; // The (LDAP *) handle returned by
- // ldap_init
- LPCWSTR pwszLdapUrl;
- } CERT_LDAP_STORE_OPENED_PARA, *PCERT_LDAP_STORE_OPENED_PARA;
- // Set this flag if the above CERT_LDAP_STORE_OPENED_FLAG is set and
- // you want an ldap_unbind() of the above pvLdapSessionHandle when the
- // store is closed. Note, if CertOpenStore() fails, then, ldap_unbind()
- // isn't called.
- #define CERT_LDAP_STORE_UNBIND_FLAG 0x80000
- //+-------------------------------------------------------------------------
- // Open the cert store using the specified store provider.
- //
- // If CERT_STORE_DELETE_FLAG is set, then, the store is deleted. NULL is
- // returned for both success and failure. However, GetLastError() returns 0
- // for success and nonzero for failure.
- //
- // If CERT_STORE_SET_LOCALIZED_NAME_FLAG is set, then, if supported, the
- // provider sets the store's CERT_STORE_LOCALIZED_NAME_PROP_ID property.
- // The store's localized name can be retrieved by calling
- // CertSetStoreProperty(dwPropID = CERT_STORE_LOCALIZED_NAME_PROP_ID).
- // This flag is supported by the following providers (and their sz_
- // equivalent):
- // CERT_STORE_PROV_FILENAME_A
- // CERT_STORE_PROV_FILENAME_W
- // CERT_STORE_PROV_SYSTEM_A
- // CERT_STORE_PROV_SYSTEM_W
- // CERT_STORE_PROV_SYSTEM_REGISTRY_A
- // CERT_STORE_PROV_SYSTEM_REGISTRY_W
- // CERT_STORE_PROV_PHYSICAL_W
- //
- // If CERT_STORE_DEFER_CLOSE_UNTIL_LAST_FREE_FLAG is set, then, the
- // closing of the store's provider is deferred until all certificate,
- // CRL and CTL contexts obtained from the store are freed. Also,
- // if a non NULL HCRYPTPROV was passed, then, it will continue to be used.
- // By default, the store's provider is closed on the final CertCloseStore.
- // If this flag isn't set, then, any property changes made to previously
- // duplicated contexts after the final CertCloseStore will not be persisted.
- // By setting this flag, property changes made
- // after the CertCloseStore will be persisted. Note, setting this flag
- // causes extra overhead in doing context duplicates and frees.
- // If CertCloseStore is called with CERT_CLOSE_STORE_FORCE_FLAG, then,
- // the CERT_STORE_DEFER_CLOSE_UNTIL_LAST_FREE_FLAG flag is ignored.
- //
- // CERT_STORE_MANIFOLD_FLAG can be set to check for certificates having the
- // manifold extension and archive the "older" certificates with the same
- // manifold extension value. A certificate is archived by setting the
- // CERT_ARCHIVED_PROP_ID.
- //
- // By default, contexts having the CERT_ARCHIVED_PROP_ID, are skipped
- // during enumeration. CERT_STORE_ENUM_ARCHIVED_FLAG can be set to include
- // archived contexts when enumerating. Note, contexts having the
- // CERT_ARCHIVED_PROP_ID are still found for explicit finds, such as,
- // finding a context with a specific hash or finding a certificate having
- // a specific issuer and serial number.
- //
- // CERT_STORE_UPDATE_KEYID_FLAG can be set to also update the Key Identifier's
- // CERT_KEY_PROV_INFO_PROP_ID property whenever a certificate's
- // CERT_KEY_IDENTIFIER_PROP_ID or CERT_KEY_PROV_INFO_PROP_ID property is set
- // and the other property already exists. If the Key Identifier's
- // CERT_KEY_PROV_INFO_PROP_ID already exists, it isn't updated. Any
- // errors encountered are silently ignored.
- //
- // By default, this flag is implicitly set for the "My\.Default" CurrentUser
- // and LocalMachine physical stores.
- //
- // CERT_STORE_READONLY_FLAG can be set to open the store as read only.
- // Otherwise, the store is opened as read/write.
- //
- // CERT_STORE_OPEN_EXISTING_FLAG can be set to only open an existing
- // store. CERT_STORE_CREATE_NEW_FLAG can be set to create a new store and
- // fail if the store already exists. Otherwise, the default is to open
- // an existing store or create a new store if it doesn't already exist.
- //
- // hCryptProv specifies the crypto provider to use to create the hash
- // properties or verify the signature of a subject certificate or CRL.
- // The store doesn't need to use a private
- // key. If the CERT_STORE_NO_CRYPT_RELEASE_FLAG isn't set, hCryptProv is
- // CryptReleaseContext'ed on the final CertCloseStore.
- //
- // Note, if the open fails, hCryptProv is released if it would have been
- // released when the store was closed.
- //
- // If hCryptProv is zero, then, the default provider and container for the
- // PROV_RSA_FULL provider type is CryptAcquireContext'ed with
- // CRYPT_VERIFYCONTEXT access. The CryptAcquireContext is deferred until
- // the first create hash or verify signature. In addition, once acquired,
- // the default provider isn't released until process exit when crypt32.dll
- // is unloaded. The acquired default provider is shared across all stores
- // and threads.
- //
- // After initializing the store's data structures and optionally acquiring a
- // default crypt provider, CertOpenStore calls CryptGetOIDFunctionAddress to
- // get the address of the CRYPT_OID_OPEN_STORE_PROV_FUNC specified by
- // lpszStoreProvider. Since a store can contain certificates with different
- // encoding types, CryptGetOIDFunctionAddress is called with dwEncodingType
- // set to 0 and not the dwEncodingType passed to CertOpenStore.
- // PFN_CERT_DLL_OPEN_STORE_FUNC specifies the signature of the provider's
- // open function. This provider open function is called to load the
- // store's certificates and CRLs. Optionally, the provider may return an
- // array of functions called before a certificate or CRL is added or deleted
- // or has a property that is set.
- //
- // Use of the dwEncodingType parameter is provider dependent. The type
- // definition for pvPara also depends on the provider.
- //
- // Store providers are installed or registered via
- // CryptInstallOIDFunctionAddress or CryptRegisterOIDFunction, where,
- // dwEncodingType is 0 and pszFuncName is CRYPT_OID_OPEN_STORE_PROV_FUNC.
- //
- // Here's a list of the predefined provider types (implemented in crypt32.dll):
- //
- // CERT_STORE_PROV_MSG:
- // Gets the certificates and CRLs from the specified cryptographic message.
- // dwEncodingType contains the message and certificate encoding types.
- // The message's handle is passed in pvPara. Given,
- // HCRYPTMSG hCryptMsg; pvPara = (const void *) hCryptMsg;
- //
- // CERT_STORE_PROV_MEMORY
- // sz_CERT_STORE_PROV_MEMORY:
- // Opens a store without any initial certificates or CRLs. pvPara
- // isn't used.
- //
- // CERT_STORE_PROV_FILE:
- // Reads the certificates and CRLs from the specified file. The file's
- // handle is passed in pvPara. Given,
- // HANDLE hFile; pvPara = (const void *) hFile;
- //
- // For a successful open, the file pointer is advanced past
- // the certificates and CRLs and their properties read from the file.
- // Note, only expects a serialized store and not a file containing
- // either a PKCS #7 signed message or a single encoded certificate.
- //
- // The hFile isn't closed.
- //
- // CERT_STORE_PROV_REG:
- // Reads the certificates and CRLs from the registry. The registry's
- // key handle is passed in pvPara. Given,
- // HKEY hKey; pvPara = (const void *) hKey;
- //
- // The input hKey isn't closed by the provider. Before returning, the
- // provider opens it own copy of the hKey.
- //
- // If CERT_STORE_READONLY_FLAG is set, then, the registry subkeys are
- // RegOpenKey'ed with KEY_READ_ACCESS. Otherwise, the registry subkeys
- // are RegCreateKey'ed with KEY_ALL_ACCESS.
- //
- // This provider returns the array of functions for reading, writing,
- // deleting and property setting certificates and CRLs.
- // Any changes to the opened store are immediately pushed through to
- // the registry. However, if CERT_STORE_READONLY_FLAG is set, then,
- // writing, deleting or property setting results in a
- // SetLastError(E_ACCESSDENIED).
- //
- // Note, all the certificates and CRLs are read from the registry
- // when the store is opened. The opened store serves as a write through
- // cache.
- //
- // If CERT_REGISTRY_STORE_SERIALIZED_FLAG is set, then, the
- // contexts are persisted as a single serialized store subkey in the
- // registry.
- //
- // CERT_STORE_PROV_PKCS7:
- // sz_CERT_STORE_PROV_PKCS7:
- // Gets the certificates and CRLs from the encoded PKCS #7 signed message.
- // dwEncodingType specifies the message and certificate encoding types.
- // The pointer to the encoded message's blob is passed in pvPara. Given,
- // CRYPT_DATA_BLOB EncodedMsg; pvPara = (const void *) &EncodedMsg;
- //
- // Note, also supports the IE3.0 special version of a
- // PKCS #7 signed message referred to as a "SPC" formatted message.
- //
- // CERT_STORE_PROV_SERIALIZED:
- // sz_CERT_STORE_PROV_SERIALIZED:
- // Gets the certificates and CRLs from memory containing a serialized
- // store. The pointer to the serialized memory blob is passed in pvPara.
- // Given,
- // CRYPT_DATA_BLOB Serialized; pvPara = (const void *) &Serialized;
- //
- // CERT_STORE_PROV_FILENAME_A:
- // CERT_STORE_PROV_FILENAME_W:
- // CERT_STORE_PROV_FILENAME:
- // sz_CERT_STORE_PROV_FILENAME_W:
- // sz_CERT_STORE_PROV_FILENAME:
- // Opens the file and first attempts to read as a serialized store. Then,
- // as a PKCS #7 signed message. Finally, as a single encoded certificate.
- // The filename is passed in pvPara. The filename is UNICODE for the
- // "_W" provider and ASCII for the "_A" provider. For "_W": given,
- // LPCWSTR pwszFilename; pvPara = (const void *) pwszFilename;
- // For "_A": given,
- // LPCSTR pszFilename; pvPara = (const void *) pszFilename;
- //
- // Note, the default (without "_A" or "_W") is unicode.
- //
- // Note, also supports the reading of the IE3.0 special version of a
- // PKCS #7 signed message file referred to as a "SPC" formatted file.
- //
- // CERT_STORE_PROV_SYSTEM_A:
- // CERT_STORE_PROV_SYSTEM_W:
- // CERT_STORE_PROV_SYSTEM:
- // sz_CERT_STORE_PROV_SYSTEM_W:
- // sz_CERT_STORE_PROV_SYSTEM:
- // Opens the specified logical "System" store. The upper word of the
- // dwFlags parameter is used to specify the location of the system store.
- //
- // A "System" store is a collection consisting of one or more "Physical"
- // stores. A "Physical" store is registered via the
- // CertRegisterPhysicalStore API. Each of the registered physical stores
- // is CertStoreOpen'ed and added to the collection via
- // CertAddStoreToCollection.
- //
- // The CERT_SYSTEM_STORE_CURRENT_USER, CERT_SYSTEM_STORE_LOCAL_MACHINE,
- // CERT_SYSTEM_STORE_CURRENT_SERVICE, CERT_SYSTEM_STORE_SERVICES,
- // CERT_SYSTEM_STORE_USERS, CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY,
- // CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY and
- // CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRSE
- // system stores by default have a "SystemRegistry" store that is
- // opened and added to the collection.
- //
- // The system store name is passed in pvPara. The name is UNICODE for the
- // "_W" provider and ASCII for the "_A" provider. For "_W": given,
- // LPCWSTR pwszSystemName; pvPara = (const void *) pwszSystemName;
- // For "_A": given,
- // LPCSTR pszSystemName; pvPara = (const void *) pszSystemName;
- //
- // Note, the default (without "_A" or "_W") is UNICODE.
- //
- // The system store name can't contain any backslashes.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvPara
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure instead
- // of pointing to a null terminated UNICODE or ASCII string.
- // Sibling physical stores are also opened as relocated using
- // pvPara's hKeyBase.
- //
- // The CERT_SYSTEM_STORE_SERVICES or CERT_SYSTEM_STORE_USERS system
- // store name must be prefixed with the ServiceName or UserName.
- // For example, "ServiceName\Trust".
- //
- // Stores on remote computers can be accessed for the
- // CERT_SYSTEM_STORE_LOCAL_MACHINE, CERT_SYSTEM_STORE_SERVICES,
- // CERT_SYSTEM_STORE_USERS, CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY
- // or CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE
- // locations by prepending the computer name. For example, a remote
- // local machine store is accessed via "\\ComputerName\Trust" or
- // "ComputerName\Trust". A remote service store is accessed via
- // "\\ComputerName\ServiceName\Trust". The leading "\\" backslashes are
- // optional in the ComputerName.
- //
- // If CERT_STORE_READONLY_FLAG is set, then, the registry is
- // RegOpenKey'ed with KEY_READ_ACCESS. Otherwise, the registry is
- // RegCreateKey'ed with KEY_ALL_ACCESS.
- //
- // The "root" store is treated differently from the other system
- // stores. Before a certificate is added to or deleted from the "root"
- // store, a pop up message box is displayed. The certificate's subject,
- // issuer, serial number, time validity, sha1 and md5 thumbprints are
- // displayed. The user is given the option to do the add or delete.
- // If they don't allow the operation, LastError is set to E_ACCESSDENIED.
- //
- // CERT_STORE_PROV_SYSTEM_REGISTRY_A
- // CERT_STORE_PROV_SYSTEM_REGISTRY_W
- // CERT_STORE_PROV_SYSTEM_REGISTRY
- // sz_CERT_STORE_PROV_SYSTEM_REGISTRY_W
- // sz_CERT_STORE_PROV_SYSTEM_REGISTRY
- // Opens the "System" store's default "Physical" store residing in the
- // registry. The upper word of the dwFlags
- // parameter is used to specify the location of the system store.
- //
- // After opening the registry key associated with the system name,
- // the CERT_STORE_PROV_REG provider is called to complete the open.
- //
- // The system store name is passed in pvPara. The name is UNICODE for the
- // "_W" provider and ASCII for the "_A" provider. For "_W": given,
- // LPCWSTR pwszSystemName; pvPara = (const void *) pwszSystemName;
- // For "_A": given,
- // LPCSTR pszSystemName; pvPara = (const void *) pszSystemName;
- //
- // Note, the default (without "_A" or "_W") is UNICODE.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvPara
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure instead
- // of pointing to a null terminated UNICODE or ASCII string.
- //
- // See above for details on prepending a ServiceName and/or ComputerName
- // to the store name.
- //
- // If CERT_STORE_READONLY_FLAG is set, then, the registry is
- // RegOpenKey'ed with KEY_READ_ACCESS. Otherwise, the registry is
- // RegCreateKey'ed with KEY_ALL_ACCESS.
- //
- // The "root" store is treated differently from the other system
- // stores. Before a certificate is added to or deleted from the "root"
- // store, a pop up message box is displayed. The certificate's subject,
- // issuer, serial number, time validity, sha1 and md5 thumbprints are
- // displayed. The user is given the option to do the add or delete.
- // If they don't allow the operation, LastError is set to E_ACCESSDENIED.
- //
- // CERT_STORE_PROV_PHYSICAL_W
- // CERT_STORE_PROV_PHYSICAL
- // sz_CERT_STORE_PROV_PHYSICAL_W
- // sz_CERT_STORE_PROV_PHYSICAL
- // Opens the specified "Physical" store in the "System" store.
- //
- // Both the system store and physical names are passed in pvPara. The
- // names are separated with an intervening "\". For example,
- // "Root\.Default". The string is UNICODE.
- //
- // The system and physical store names can't contain any backslashes.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvPara
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure instead
- // of pointing to a null terminated UNICODE string.
- // The specified physical store is opened as relocated using pvPara's
- // hKeyBase.
- //
- // For CERT_SYSTEM_STORE_SERVICES or CERT_SYSTEM_STORE_USERS,
- // the system and physical store names
- // must be prefixed with the ServiceName or UserName. For example,
- // "ServiceName\Root\.Default".
- //
- // Physical stores on remote computers can be accessed for the
- // CERT_SYSTEM_STORE_LOCAL_MACHINE, CERT_SYSTEM_STORE_SERVICES,
- // CERT_SYSTEM_STORE_USERS, CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY
- // or CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE
- // locations by prepending the computer name. For example, a remote
- // local machine store is accessed via "\\ComputerName\Root\.Default"
- // or "ComputerName\Root\.Default". A remote service store is
- // accessed via "\\ComputerName\ServiceName\Root\.Default". The
- // leading "\\" backslashes are optional in the ComputerName.
- //
- // CERT_STORE_PROV_COLLECTION
- // sz_CERT_STORE_PROV_COLLECTION
- // Opens a store that is a collection of other stores. Stores are
- // added or removed to/from the collection via the CertAddStoreToCollection
- // and CertRemoveStoreFromCollection APIs.
- //
- // CERT_STORE_PROV_SMART_CARD_W
- // CERT_STORE_PROV_SMART_CARD
- // sz_CERT_STORE_PROV_SMART_CARD_W
- // sz_CERT_STORE_PROV_SMART_CARD
- // Opens a store instantiated over a particular smart card storage. pvPara
- // identifies where on the card the store is located and is of the
- // following format:
- //
- // Card Name\Provider Name\Provider Type[\Container Name]
- //
- // Container Name is optional and if NOT specified the Card Name is used
- // as the Container Name. Future versions of the provider will support
- // instantiating the store over the entire card in which case just
- // Card Name ( or id ) will be sufficient.
- //
- // Here's a list of the predefined provider types (implemented in
- // cryptnet.dll):
- //
- // CERT_STORE_PROV_LDAP_W
- // CERT_STORE_PROV_LDAP
- // sz_CERT_STORE_PROV_LDAP_W
- // sz_CERT_STORE_PROV_LDAP
- // Opens a store over the results of the query specified by and LDAP
- // URL which is passed in via pvPara. In order to do writes to the
- // store the URL must specify a BASE query, no filter and a single
- // attribute.
- //
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCERTSTORE
- WINAPI
- CertOpenStore(
- IN LPCSTR lpszStoreProvider,
- IN DWORD dwEncodingType,
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwFlags,
- IN const void *pvPara
- );
- //+-------------------------------------------------------------------------
- // OID Installable Certificate Store Provider Data Structures
- //--------------------------------------------------------------------------
- // Handle returned by the store provider when opened.
- typedef void *HCERTSTOREPROV;
- // Store Provider OID function's pszFuncName.
- #define CRYPT_OID_OPEN_STORE_PROV_FUNC "CertDllOpenStoreProv"
- // Note, the Store Provider OID function's dwEncodingType is always 0.
- // The following information is returned by the provider when opened. Its
- // zeroed with cbSize set before the provider is called. If the provider
- // doesn't need to be called again after the open it doesn't need to
- // make any updates to the CERT_STORE_PROV_INFO.
- typedef struct _CERT_STORE_PROV_INFO {
- DWORD cbSize;
- DWORD cStoreProvFunc;
- void **rgpvStoreProvFunc;
- HCERTSTOREPROV hStoreProv;
- DWORD dwStoreProvFlags;
- HCRYPTOIDFUNCADDR hStoreProvFuncAddr2;
- } CERT_STORE_PROV_INFO, *PCERT_STORE_PROV_INFO;
- // Definition of the store provider's open function.
- //
- // *pStoreProvInfo has been zeroed before the call.
- //
- // Note, pStoreProvInfo->cStoreProvFunc should be set last. Once set,
- // all subsequent store calls, such as CertAddSerializedElementToStore will
- // call the appropriate provider callback function.
- typedef BOOL (WINAPI *PFN_CERT_DLL_OPEN_STORE_PROV_FUNC)(
- IN LPCSTR lpszStoreProvider,
- IN DWORD dwEncodingType,
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwFlags,
- IN const void *pvPara,
- IN HCERTSTORE hCertStore,
- IN OUT PCERT_STORE_PROV_INFO pStoreProvInfo
- );
- // The open callback sets the following flag, if it maintains its
- // contexts externally and not in the cached store.
- #define CERT_STORE_PROV_EXTERNAL_FLAG 0x1
- // The open callback sets the following flag for a successful delete.
- // When set, the close callback isn't called.
- #define CERT_STORE_PROV_DELETED_FLAG 0x2
- // The open callback sets the following flag if it doesn't persist store
- // changes.
- #define CERT_STORE_PROV_NO_PERSIST_FLAG 0x4
- // The open callback sets the following flag if the contexts are persisted
- // to a system store.
- #define CERT_STORE_PROV_SYSTEM_STORE_FLAG 0x8
- // The open callback sets the following flag if the contexts are persisted
- // to a LocalMachine system store.
- #define CERT_STORE_PROV_LM_SYSTEM_STORE_FLAG 0x10
- // Indices into the store provider's array of callback functions.
- //
- // The provider can implement any subset of the following functions. It
- // sets pStoreProvInfo->cStoreProvFunc to the last index + 1 and any
- // preceding not implemented functions to NULL.
- #define CERT_STORE_PROV_CLOSE_FUNC 0
- #define CERT_STORE_PROV_READ_CERT_FUNC 1
- #define CERT_STORE_PROV_WRITE_CERT_FUNC 2
- #define CERT_STORE_PROV_DELETE_CERT_FUNC 3
- #define CERT_STORE_PROV_SET_CERT_PROPERTY_FUNC 4
- #define CERT_STORE_PROV_READ_CRL_FUNC 5
- #define CERT_STORE_PROV_WRITE_CRL_FUNC 6
- #define CERT_STORE_PROV_DELETE_CRL_FUNC 7
- #define CERT_STORE_PROV_SET_CRL_PROPERTY_FUNC 8
- #define CERT_STORE_PROV_READ_CTL_FUNC 9
- #define CERT_STORE_PROV_WRITE_CTL_FUNC 10
- #define CERT_STORE_PROV_DELETE_CTL_FUNC 11
- #define CERT_STORE_PROV_SET_CTL_PROPERTY_FUNC 12
- #define CERT_STORE_PROV_CONTROL_FUNC 13
- #define CERT_STORE_PROV_FIND_CERT_FUNC 14
- #define CERT_STORE_PROV_FREE_FIND_CERT_FUNC 15
- #define CERT_STORE_PROV_GET_CERT_PROPERTY_FUNC 16
- #define CERT_STORE_PROV_FIND_CRL_FUNC 17
- #define CERT_STORE_PROV_FREE_FIND_CRL_FUNC 18
- #define CERT_STORE_PROV_GET_CRL_PROPERTY_FUNC 19
- #define CERT_STORE_PROV_FIND_CTL_FUNC 20
- #define CERT_STORE_PROV_FREE_FIND_CTL_FUNC 21
- #define CERT_STORE_PROV_GET_CTL_PROPERTY_FUNC 22
- // Called by CertCloseStore when the store's reference count is
- // decremented to 0.
- typedef void (WINAPI *PFN_CERT_STORE_PROV_CLOSE)(
- IN HCERTSTOREPROV hStoreProv,
- IN DWORD dwFlags
- );
- // Currently not called directly by the store APIs. However, may be exported
- // to support other providers based on it.
- //
- // Reads the provider's copy of the certificate context. If it exists,
- // creates a new certificate context.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_READ_CERT)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_CONTEXT pStoreCertContext,
- IN DWORD dwFlags,
- OUT PCCERT_CONTEXT *ppProvCertContext
- );
- #define CERT_STORE_PROV_WRITE_ADD_FLAG 0x1
- // Called by CertAddEncodedCertificateToStore,
- // CertAddCertificateContextToStore or CertAddSerializedElementToStore before
- // adding to the store. The CERT_STORE_PROV_WRITE_ADD_FLAG is set. In
- // addition to the encoded certificate, the added pCertContext might also
- // have properties.
- //
- // Returns TRUE if its OK to update the the store.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_WRITE_CERT)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwFlags
- );
- // Called by CertDeleteCertificateFromStore before deleting from the
- // store.
- //
- // Returns TRUE if its OK to delete from the store.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_DELETE_CERT)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwFlags
- );
- // Called by CertSetCertificateContextProperty before setting the
- // certificate's property. Also called by CertGetCertificateContextProperty,
- // when getting a hash property that needs to be created and then persisted
- // via the set.
- //
- // Upon input, the property hasn't been set for the pCertContext parameter.
- //
- // Returns TRUE if its OK to set the property.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_SET_CERT_PROPERTY)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN const void *pvData
- );
- // Currently not called directly by the store APIs. However, may be exported
- // to support other providers based on it.
- //
- // Reads the provider's copy of the CRL context. If it exists,
- // creates a new CRL context.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_READ_CRL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCRL_CONTEXT pStoreCrlContext,
- IN DWORD dwFlags,
- OUT PCCRL_CONTEXT *ppProvCrlContext
- );
- // Called by CertAddEncodedCRLToStore,
- // CertAddCRLContextToStore or CertAddSerializedElementToStore before
- // adding to the store. The CERT_STORE_PROV_WRITE_ADD_FLAG is set. In
- // addition to the encoded CRL, the added pCertContext might also
- // have properties.
- //
- // Returns TRUE if its OK to update the the store.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_WRITE_CRL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwFlags
- );
- // Called by CertDeleteCRLFromStore before deleting from the store.
- //
- // Returns TRUE if its OK to delete from the store.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_DELETE_CRL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwFlags
- );
- // Called by CertSetCRLContextProperty before setting the
- // CRL's property. Also called by CertGetCRLContextProperty,
- // when getting a hash property that needs to be created and then persisted
- // via the set.
- //
- // Upon input, the property hasn't been set for the pCrlContext parameter.
- //
- // Returns TRUE if its OK to set the property.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_SET_CRL_PROPERTY)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN const void *pvData
- );
- // Currently not called directly by the store APIs. However, may be exported
- // to support other providers based on it.
- //
- // Reads the provider's copy of the CTL context. If it exists,
- // creates a new CTL context.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_READ_CTL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCTL_CONTEXT pStoreCtlContext,
- IN DWORD dwFlags,
- OUT PCCTL_CONTEXT *ppProvCtlContext
- );
- // Called by CertAddEncodedCTLToStore,
- // CertAddCTLContextToStore or CertAddSerializedElementToStore before
- // adding to the store. The CERT_STORE_PROV_WRITE_ADD_FLAG is set. In
- // addition to the encoded CTL, the added pCertContext might also
- // have properties.
- //
- // Returns TRUE if its OK to update the the store.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_WRITE_CTL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwFlags
- );
- // Called by CertDeleteCTLFromStore before deleting from the store.
- //
- // Returns TRUE if its OK to delete from the store.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_DELETE_CTL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwFlags
- );
- // Called by CertSetCTLContextProperty before setting the
- // CTL's property. Also called by CertGetCTLContextProperty,
- // when getting a hash property that needs to be created and then persisted
- // via the set.
- //
- // Upon input, the property hasn't been set for the pCtlContext parameter.
- //
- // Returns TRUE if its OK to set the property.
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_SET_CTL_PROPERTY)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN const void *pvData
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_CONTROL)(
- IN HCERTSTOREPROV hStoreProv,
- IN DWORD dwFlags,
- IN DWORD dwCtrlType,
- IN void const *pvCtrlPara
- );
- typedef struct _CERT_STORE_PROV_FIND_INFO {
- DWORD cbSize;
- DWORD dwMsgAndCertEncodingType;
- DWORD dwFindFlags;
- DWORD dwFindType;
- const void *pvFindPara;
- } CERT_STORE_PROV_FIND_INFO, *PCERT_STORE_PROV_FIND_INFO;
- typedef const CERT_STORE_PROV_FIND_INFO CCERT_STORE_PROV_FIND_INFO,
- *PCCERT_STORE_PROV_FIND_INFO;
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_FIND_CERT)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_STORE_PROV_FIND_INFO pFindInfo,
- IN PCCERT_CONTEXT pPrevCertContext,
- IN DWORD dwFlags,
- IN OUT void **ppvStoreProvFindInfo,
- OUT PCCERT_CONTEXT *ppProvCertContext
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_FREE_FIND_CERT)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_CONTEXT pCertContext,
- IN void *pvStoreProvFindInfo,
- IN DWORD dwFlags
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_GET_CERT_PROPERTY)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_FIND_CRL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_STORE_PROV_FIND_INFO pFindInfo,
- IN PCCRL_CONTEXT pPrevCrlContext,
- IN DWORD dwFlags,
- IN OUT void **ppvStoreProvFindInfo,
- OUT PCCRL_CONTEXT *ppProvCrlContext
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_FREE_FIND_CRL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCRL_CONTEXT pCrlContext,
- IN void *pvStoreProvFindInfo,
- IN DWORD dwFlags
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_GET_CRL_PROPERTY)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_FIND_CTL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCERT_STORE_PROV_FIND_INFO pFindInfo,
- IN PCCTL_CONTEXT pPrevCtlContext,
- IN DWORD dwFlags,
- IN OUT void **ppvStoreProvFindInfo,
- OUT PCCTL_CONTEXT *ppProvCtlContext
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_FREE_FIND_CTL)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCTL_CONTEXT pCtlContext,
- IN void *pvStoreProvFindInfo,
- IN DWORD dwFlags
- );
- typedef BOOL (WINAPI *PFN_CERT_STORE_PROV_GET_CTL_PROPERTY)(
- IN HCERTSTOREPROV hStoreProv,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- //+-------------------------------------------------------------------------
- // Duplicate a cert store handle
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCERTSTORE
- WINAPI
- CertDuplicateStore(
- IN HCERTSTORE hCertStore
- );
- #define CERT_STORE_SAVE_AS_STORE 1
- #define CERT_STORE_SAVE_AS_PKCS7 2
- #define CERT_STORE_SAVE_TO_FILE 1
- #define CERT_STORE_SAVE_TO_MEMORY 2
- #define CERT_STORE_SAVE_TO_FILENAME_A 3
- #define CERT_STORE_SAVE_TO_FILENAME_W 4
- #define CERT_STORE_SAVE_TO_FILENAME CERT_STORE_SAVE_TO_FILENAME_W
- //+-------------------------------------------------------------------------
- // Save the cert store. Extended version with lots of options.
- //
- // According to the dwSaveAs parameter, the store can be saved as a
- // serialized store (CERT_STORE_SAVE_AS_STORE) containing properties in
- // addition to encoded certificates, CRLs and CTLs or the store can be saved
- // as a PKCS #7 signed message (CERT_STORE_SAVE_AS_PKCS7) which doesn't
- // include the properties or CTLs.
- //
- // Note, the CERT_KEY_CONTEXT_PROP_ID property (and its
- // CERT_KEY_PROV_HANDLE_PROP_ID or CERT_KEY_SPEC_PROP_ID) isn't saved into
- // a serialized store.
- //
- // For CERT_STORE_SAVE_AS_PKCS7, the dwEncodingType specifies the message
- // encoding type. The dwEncodingType parameter isn't used for
- // CERT_STORE_SAVE_AS_STORE.
- //
- // The dwFlags parameter currently isn't used and should be set to 0.
- //
- // The dwSaveTo and pvSaveToPara parameters specify where to save the
- // store as follows:
- // CERT_STORE_SAVE_TO_FILE:
- // Saves to the specified file. The file's handle is passed in
- // pvSaveToPara. Given,
- // HANDLE hFile; pvSaveToPara = (void *) hFile;
- //
- // For a successful save, the file pointer is positioned after the
- // last write.
- //
- // CERT_STORE_SAVE_TO_MEMORY:
- // Saves to the specified memory blob. The pointer to
- // the memory blob is passed in pvSaveToPara. Given,
- // CRYPT_DATA_BLOB SaveBlob; pvSaveToPara = (void *) &SaveBlob;
- // Upon entry, the SaveBlob's pbData and cbData need to be initialized.
- // Upon return, cbData is updated with the actual length.
- // For a length only calculation, pbData should be set to NULL. If
- // pbData is non-NULL and cbData isn't large enough, FALSE is returned
- // with a last error of ERRROR_MORE_DATA.
- //
- // CERT_STORE_SAVE_TO_FILENAME_A:
- // CERT_STORE_SAVE_TO_FILENAME_W:
- // CERT_STORE_SAVE_TO_FILENAME:
- // Opens the file and saves to it. The filename is passed in pvSaveToPara.
- // The filename is UNICODE for the "_W" option and ASCII for the "_A"
- // option. For "_W": given,
- // LPCWSTR pwszFilename; pvSaveToPara = (void *) pwszFilename;
- // For "_A": given,
- // LPCSTR pszFilename; pvSaveToPara = (void *) pszFilename;
- //
- // Note, the default (without "_A" or "_W") is UNICODE.
- //
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSaveStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwEncodingType,
- IN DWORD dwSaveAs,
- IN DWORD dwSaveTo,
- IN OUT void *pvSaveToPara,
- IN DWORD dwFlags
- );
- //+-------------------------------------------------------------------------
- // Certificate Store close flags
- //--------------------------------------------------------------------------
- #define CERT_CLOSE_STORE_FORCE_FLAG 0x00000001
- #define CERT_CLOSE_STORE_CHECK_FLAG 0x00000002
- //+-------------------------------------------------------------------------
- // Close a cert store handle.
- //
- // There needs to be a corresponding close for each open and duplicate.
- //
- // Even on the final close, the cert store isn't freed until all of its
- // certificate and CRL contexts have also been freed.
- //
- // On the final close, the hCryptProv passed to CertStoreOpen is
- // CryptReleaseContext'ed.
- //
- // To force the closure of the store with all of its memory freed, set the
- // CERT_STORE_CLOSE_FORCE_FLAG. This flag should be set when the caller does
- // its own reference counting and wants everything to vanish.
- //
- // To check if all the store's certificates and CRLs have been freed and that
- // this is the last CertCloseStore, set the CERT_CLOSE_STORE_CHECK_FLAG. If
- // set and certs, CRLs or stores still need to be freed/closed, FALSE is
- // returned with LastError set to CRYPT_E_PENDING_CLOSE. Note, for FALSE,
- // the store is still closed. This is a diagnostic flag.
- //
- // LastError is preserved unless CERT_CLOSE_STORE_CHECK_FLAG is set and FALSE
- // is returned.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertCloseStore(
- IN HCERTSTORE hCertStore,
- DWORD dwFlags
- );
- //+-------------------------------------------------------------------------
- // Get the subject certificate context uniquely identified by its Issuer and
- // SerialNumber from the store.
- //
- // If the certificate isn't found, NULL is returned. Otherwise, a pointer to
- // a read only CERT_CONTEXT is returned. CERT_CONTEXT must be freed by calling
- // CertFreeCertificateContext. CertDuplicateCertificateContext can be called to make a
- // duplicate.
- //
- // The returned certificate might not be valid. Normally, it would be
- // verified when getting its issuer certificate (CertGetIssuerCertificateFromStore).
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CONTEXT
- WINAPI
- CertGetSubjectCertificateFromStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwCertEncodingType,
- IN PCERT_INFO pCertId // Only the Issuer and SerialNumber
- // fields are used
- );
- //+-------------------------------------------------------------------------
- // Enumerate the certificate contexts in the store.
- //
- // If a certificate isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CERT_CONTEXT is returned. CERT_CONTEXT
- // must be freed by calling CertFreeCertificateContext or is freed when passed as the
- // pPrevCertContext on a subsequent call. CertDuplicateCertificateContext
- // can be called to make a duplicate.
- //
- // pPrevCertContext MUST BE NULL to enumerate the first
- // certificate in the store. Successive certificates are enumerated by setting
- // pPrevCertContext to the CERT_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevCertContext is always CertFreeCertificateContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CONTEXT
- WINAPI
- CertEnumCertificatesInStore(
- IN HCERTSTORE hCertStore,
- IN PCCERT_CONTEXT pPrevCertContext
- );
- //+-------------------------------------------------------------------------
- // Find the first or next certificate context in the store.
- //
- // The certificate is found according to the dwFindType and its pvFindPara.
- // See below for a list of the find types and its parameters.
- //
- // Currently dwFindFlags is only used for CERT_FIND_SUBJECT_ATTR,
- // CERT_FIND_ISSUER_ATTR or CERT_FIND_CTL_USAGE. Otherwise, must be set to 0.
- //
- // Usage of dwCertEncodingType depends on the dwFindType.
- //
- // If the first or next certificate isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CERT_CONTEXT is returned. CERT_CONTEXT
- // must be freed by calling CertFreeCertificateContext or is freed when passed as the
- // pPrevCertContext on a subsequent call. CertDuplicateCertificateContext
- // can be called to make a duplicate.
- //
- // pPrevCertContext MUST BE NULL on the first
- // call to find the certificate. To find the next certificate, the
- // pPrevCertContext is set to the CERT_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevCertContext is always CertFreeCertificateContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CONTEXT
- WINAPI
- CertFindCertificateInStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwCertEncodingType,
- IN DWORD dwFindFlags,
- IN DWORD dwFindType,
- IN const void *pvFindPara,
- IN PCCERT_CONTEXT pPrevCertContext
- );
- //+-------------------------------------------------------------------------
- // Certificate comparison functions
- //--------------------------------------------------------------------------
- #define CERT_COMPARE_MASK 0xFFFF
- #define CERT_COMPARE_SHIFT 16
- #define CERT_COMPARE_ANY 0
- #define CERT_COMPARE_SHA1_HASH 1
- #define CERT_COMPARE_NAME 2
- #define CERT_COMPARE_ATTR 3
- #define CERT_COMPARE_MD5_HASH 4
- #define CERT_COMPARE_PROPERTY 5
- #define CERT_COMPARE_PUBLIC_KEY 6
- #define CERT_COMPARE_HASH CERT_COMPARE_SHA1_HASH
- #define CERT_COMPARE_NAME_STR_A 7
- #define CERT_COMPARE_NAME_STR_W 8
- #define CERT_COMPARE_KEY_SPEC 9
- #define CERT_COMPARE_ENHKEY_USAGE 10
- #define CERT_COMPARE_CTL_USAGE CERT_COMPARE_ENHKEY_USAGE
- #define CERT_COMPARE_SUBJECT_CERT 11
- #define CERT_COMPARE_ISSUER_OF 12
- #define CERT_COMPARE_EXISTING 13
- #define CERT_COMPARE_SIGNATURE_HASH 14
- #define CERT_COMPARE_KEY_IDENTIFIER 15
- #define CERT_COMPARE_CERT_ID 16
- #define CERT_COMPARE_CROSS_CERT_DIST_POINTS 17
- #define CERT_COMPARE_PUBKEY_MD5_HASH 18
- //+-------------------------------------------------------------------------
- // dwFindType
- //
- // The dwFindType definition consists of two components:
- // - comparison function
- // - certificate information flag
- //--------------------------------------------------------------------------
- #define CERT_FIND_ANY (CERT_COMPARE_ANY << CERT_COMPARE_SHIFT)
- #define CERT_FIND_SHA1_HASH (CERT_COMPARE_SHA1_HASH << CERT_COMPARE_SHIFT)
- #define CERT_FIND_MD5_HASH (CERT_COMPARE_MD5_HASH << CERT_COMPARE_SHIFT)
- #define CERT_FIND_SIGNATURE_HASH (CERT_COMPARE_SIGNATURE_HASH << CERT_COMPARE_SHIFT)
- #define CERT_FIND_KEY_IDENTIFIER (CERT_COMPARE_KEY_IDENTIFIER << CERT_COMPARE_SHIFT)
- #define CERT_FIND_HASH CERT_FIND_SHA1_HASH
- #define CERT_FIND_PROPERTY (CERT_COMPARE_PROPERTY << CERT_COMPARE_SHIFT)
- #define CERT_FIND_PUBLIC_KEY (CERT_COMPARE_PUBLIC_KEY << CERT_COMPARE_SHIFT)
- #define CERT_FIND_SUBJECT_NAME (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT | \
- CERT_INFO_SUBJECT_FLAG)
- #define CERT_FIND_SUBJECT_ATTR (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT | \
- CERT_INFO_SUBJECT_FLAG)
- #define CERT_FIND_ISSUER_NAME (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT | \
- CERT_INFO_ISSUER_FLAG)
- #define CERT_FIND_ISSUER_ATTR (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT | \
- CERT_INFO_ISSUER_FLAG)
- #define CERT_FIND_SUBJECT_STR_A (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT | \
- CERT_INFO_SUBJECT_FLAG)
- #define CERT_FIND_SUBJECT_STR_W (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT | \
- CERT_INFO_SUBJECT_FLAG)
- #define CERT_FIND_SUBJECT_STR CERT_FIND_SUBJECT_STR_W
- #define CERT_FIND_ISSUER_STR_A (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT | \
- CERT_INFO_ISSUER_FLAG)
- #define CERT_FIND_ISSUER_STR_W (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT | \
- CERT_INFO_ISSUER_FLAG)
- #define CERT_FIND_ISSUER_STR CERT_FIND_ISSUER_STR_W
- #define CERT_FIND_KEY_SPEC (CERT_COMPARE_KEY_SPEC << CERT_COMPARE_SHIFT)
- #define CERT_FIND_ENHKEY_USAGE (CERT_COMPARE_ENHKEY_USAGE << CERT_COMPARE_SHIFT)
- #define CERT_FIND_CTL_USAGE CERT_FIND_ENHKEY_USAGE
- #define CERT_FIND_SUBJECT_CERT (CERT_COMPARE_SUBJECT_CERT << CERT_COMPARE_SHIFT)
- #define CERT_FIND_ISSUER_OF (CERT_COMPARE_ISSUER_OF << CERT_COMPARE_SHIFT)
- #define CERT_FIND_EXISTING (CERT_COMPARE_EXISTING << CERT_COMPARE_SHIFT)
- #define CERT_FIND_CERT_ID (CERT_COMPARE_CERT_ID << CERT_COMPARE_SHIFT)
- #define CERT_FIND_CROSS_CERT_DIST_POINTS \
- (CERT_COMPARE_CROSS_CERT_DIST_POINTS << CERT_COMPARE_SHIFT)
- #define CERT_FIND_PUBKEY_MD5_HASH \
- (CERT_COMPARE_PUBKEY_MD5_HASH << CERT_COMPARE_SHIFT)
- //+-------------------------------------------------------------------------
- // CERT_FIND_ANY
- //
- // Find any certificate.
- //
- // pvFindPara isn't used.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_HASH
- //
- // Find a certificate with the specified hash.
- //
- // pvFindPara points to a CRYPT_HASH_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_KEY_IDENTIFIER
- //
- // Find a certificate with the specified KeyIdentifier. Gets the
- // CERT_KEY_IDENTIFIER_PROP_ID property and compares with the input
- // CRYPT_HASH_BLOB.
- //
- // pvFindPara points to a CRYPT_HASH_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_PROPERTY
- //
- // Find a certificate having the specified property.
- //
- // pvFindPara points to a DWORD containing the PROP_ID
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_PUBLIC_KEY
- //
- // Find a certificate matching the specified public key.
- //
- // pvFindPara points to a CERT_PUBLIC_KEY_INFO containing the public key
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_SUBJECT_NAME
- // CERT_FIND_ISSUER_NAME
- //
- // Find a certificate with the specified subject/issuer name. Does an exact
- // match of the entire name.
- //
- // Restricts search to certificates matching the dwCertEncodingType.
- //
- // pvFindPara points to a CERT_NAME_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_SUBJECT_ATTR
- // CERT_FIND_ISSUER_ATTR
- //
- // Find a certificate with the specified subject/issuer attributes.
- //
- // Compares the attributes in the subject/issuer name with the
- // Relative Distinguished Name's (CERT_RDN) array of attributes specified in
- // pvFindPara. The comparison iterates through the CERT_RDN attributes and looks
- // for an attribute match in any of the subject/issuer's RDNs.
- //
- // The CERT_RDN_ATTR fields can have the following special values:
- // pszObjId == NULL - ignore the attribute object identifier
- // dwValueType == RDN_ANY_TYPE - ignore the value type
- // Value.pbData == NULL - match any value
- //
- // CERT_CASE_INSENSITIVE_IS_RDN_ATTRS_FLAG should be set in dwFindFlags to do
- // a case insensitive match. Otherwise, defaults to an exact, case sensitive
- // match.
- //
- // CERT_UNICODE_IS_RDN_ATTRS_FLAG should be set in dwFindFlags if the RDN was
- // initialized with unicode strings as for
- // CryptEncodeObject(X509_UNICODE_NAME).
- //
- // Restricts search to certificates matching the dwCertEncodingType.
- //
- // pvFindPara points to a CERT_RDN (defined in wincert.h).
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_SUBJECT_STR_A
- // CERT_FIND_SUBJECT_STR_W | CERT_FIND_SUBJECT_STR
- // CERT_FIND_ISSUER_STR_A
- // CERT_FIND_ISSUER_STR_W | CERT_FIND_ISSUER_STR
- //
- // Find a certificate containing the specified subject/issuer name string.
- //
- // First, the certificate's subject/issuer is converted to a name string
- // via CertNameToStrA/CertNameToStrW(CERT_SIMPLE_NAME_STR). Then, a
- // case insensitive substring within string match is performed.
- //
- // Restricts search to certificates matching the dwCertEncodingType.
- //
- // For *_STR_A, pvFindPara points to a null terminated character string.
- // For *_STR_W, pvFindPara points to a null terminated wide character string.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_KEY_SPEC
- //
- // Find a certificate having a CERT_KEY_SPEC_PROP_ID property matching
- // the specified KeySpec.
- //
- // pvFindPara points to a DWORD containing the KeySpec.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_ENHKEY_USAGE
- //
- // Find a certificate having the szOID_ENHANCED_KEY_USAGE extension or
- // the CERT_ENHKEY_USAGE_PROP_ID and matching the specified pszUsageIdentifers.
- //
- // pvFindPara points to a CERT_ENHKEY_USAGE data structure. If pvFindPara
- // is NULL or CERT_ENHKEY_USAGE's cUsageIdentifier is 0, then, matches any
- // certificate having enhanced key usage.
- //
- // If the CERT_FIND_VALID_ENHKEY_USAGE_FLAG is set, then, only does a match
- // for certificates that are valid for the specified usages. By default,
- // the ceriticate must be valid for all usages. CERT_FIND_OR_ENHKEY_USAGE_FLAG
- // can be set, if the certificate only needs to be valid for one of the
- // specified usages. Note, CertGetValidUsages() is called to get the
- // certificate's list of valid usages. Only the CERT_FIND_OR_ENHKEY_USAGE_FLAG
- // is applicable when this flag is set.
- //
- // The CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG can be set in dwFindFlags to
- // also match a certificate without either the extension or property.
- //
- // If CERT_FIND_NO_ENHKEY_USAGE_FLAG is set in dwFindFlags, finds
- // certificates without the key usage extension or property. Setting this
- // flag takes precedence over pvFindPara being NULL.
- //
- // If the CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG is set, then, only does a match
- // using the extension. If pvFindPara is NULL or cUsageIdentifier is set to
- // 0, finds certificates having the extension. If
- // CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG is set, also matches a certificate
- // without the extension. If CERT_FIND_NO_ENHKEY_USAGE_FLAG is set, finds
- // certificates without the extension.
- //
- // If the CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG is set, then, only does a match
- // using the property. If pvFindPara is NULL or cUsageIdentifier is set to
- // 0, finds certificates having the property. If
- // CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG is set, also matches a certificate
- // without the property. If CERT_FIND_NO_ENHKEY_USAGE_FLAG is set, finds
- // certificates without the property.
- //
- // If CERT_FIND_OR_ENHKEY_USAGE_FLAG is set, does an "OR" match of any of
- // the specified pszUsageIdentifiers. If not set, then, does an "AND" match
- // of all of the specified pszUsageIdentifiers.
- //--------------------------------------------------------------------------
- #define CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG 0x1
- #define CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG 0x2
- #define CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG 0x4
- #define CERT_FIND_NO_ENHKEY_USAGE_FLAG 0x8
- #define CERT_FIND_OR_ENHKEY_USAGE_FLAG 0x10
- #define CERT_FIND_VALID_ENHKEY_USAGE_FLAG 0x20
- #define CERT_FIND_OPTIONAL_CTL_USAGE_FLAG CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG
- #define CERT_FIND_EXT_ONLY_CTL_USAGE_FLAG \
- CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG
- #define CERT_FIND_PROP_ONLY_CTL_USAGE_FLAG \
- CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG
- #define CERT_FIND_NO_CTL_USAGE_FLAG CERT_FIND_NO_ENHKEY_USAGE_FLAG
- #define CERT_FIND_OR_CTL_USAGE_FLAG CERT_FIND_OR_ENHKEY_USAGE_FLAG
- #define CERT_FIND_VALID_CTL_USAGE_FLAG CERT_FIND_VALID_ENHKEY_USAGE_FLAG
- //+-------------------------------------------------------------------------
- // CERT_FIND_CERT_ID
- //
- // Find a certificate with the specified CERT_ID.
- //
- // pvFindPara points to a CERT_ID.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_FIND_CROSS_CERT_DIST_POINTS
- //
- // Find a certificate having either a cross certificate distribution
- // point extension or property.
- //
- // pvFindPara isn't used.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Get the certificate context from the store for the first or next issuer
- // of the specified subject certificate. Perform the enabled
- // verification checks on the subject. (Note, the checks are on the subject
- // using the returned issuer certificate.)
- //
- // If the first or next issuer certificate isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CERT_CONTEXT is returned. CERT_CONTEXT
- // must be freed by calling CertFreeCertificateContext or is freed when passed as the
- // pPrevIssuerContext on a subsequent call. CertDuplicateCertificateContext
- // can be called to make a duplicate.
- //
- // For a self signed subject certificate, NULL is returned with LastError set
- // to CERT_STORE_SELF_SIGNED. The enabled verification checks are still done.
- //
- // The pSubjectContext may have been obtained from this store, another store
- // or created by the caller application. When created by the caller, the
- // CertCreateCertificateContext function must have been called.
- //
- // An issuer may have multiple certificates. This may occur when the validity
- // period is about to change. pPrevIssuerContext MUST BE NULL on the first
- // call to get the issuer. To get the next certificate for the issuer, the
- // pPrevIssuerContext is set to the CERT_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevIssuerContext is always CertFreeCertificateContext'ed by
- // this function, even for an error.
- //
- // The following flags can be set in *pdwFlags to enable verification checks
- // on the subject certificate context:
- // CERT_STORE_SIGNATURE_FLAG - use the public key in the returned
- // issuer certificate to verify the
- // signature on the subject certificate.
- // Note, if pSubjectContext->hCertStore ==
- // hCertStore, the store provider might
- // be able to eliminate a redo of
- // the signature verify.
- // CERT_STORE_TIME_VALIDITY_FLAG - get the current time and verify that
- // its within the subject certificate's
- // validity period
- // CERT_STORE_REVOCATION_FLAG - check if the subject certificate is on
- // the issuer's revocation list
- //
- // If an enabled verification check fails, then, its flag is set upon return.
- // If CERT_STORE_REVOCATION_FLAG was enabled and the issuer doesn't have a
- // CRL in the store, then, CERT_STORE_NO_CRL_FLAG is set in addition to
- // the CERT_STORE_REVOCATION_FLAG.
- //
- // If CERT_STORE_SIGNATURE_FLAG or CERT_STORE_REVOCATION_FLAG is set, then,
- // CERT_STORE_NO_ISSUER_FLAG is set if it doesn't have an issuer certificate
- // in the store.
- //
- // For a verification check failure, a pointer to the issuer's CERT_CONTEXT
- // is still returned and SetLastError isn't updated.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CONTEXT
- WINAPI
- CertGetIssuerCertificateFromStore(
- IN HCERTSTORE hCertStore,
- IN PCCERT_CONTEXT pSubjectContext,
- IN OPTIONAL PCCERT_CONTEXT pPrevIssuerContext,
- IN OUT DWORD *pdwFlags
- );
- //+-------------------------------------------------------------------------
- // Perform the enabled verification checks on the subject certificate
- // using the issuer. Same checks and flags definitions as for the above
- // CertGetIssuerCertificateFromStore.
- //
- // If you are only checking CERT_STORE_TIME_VALIDITY_FLAG, then, the
- // issuer can be NULL.
- //
- // For a verification check failure, SUCCESS is still returned.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertVerifySubjectCertificateContext(
- IN PCCERT_CONTEXT pSubject,
- IN OPTIONAL PCCERT_CONTEXT pIssuer,
- IN OUT DWORD *pdwFlags
- );
- //+-------------------------------------------------------------------------
- // Duplicate a certificate context
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CONTEXT
- WINAPI
- CertDuplicateCertificateContext(
- IN PCCERT_CONTEXT pCertContext
- );
- //+-------------------------------------------------------------------------
- // Create a certificate context from the encoded certificate. The created
- // context isn't put in a store.
- //
- // Makes a copy of the encoded certificate in the created context.
- //
- // If unable to decode and create the certificate context, NULL is returned.
- // Otherwise, a pointer to a read only CERT_CONTEXT is returned.
- // CERT_CONTEXT must be freed by calling CertFreeCertificateContext.
- // CertDuplicateCertificateContext can be called to make a duplicate.
- //
- // CertSetCertificateContextProperty and CertGetCertificateContextProperty can be called
- // to store properties for the certificate.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CONTEXT
- WINAPI
- CertCreateCertificateContext(
- IN DWORD dwCertEncodingType,
- IN const BYTE *pbCertEncoded,
- IN DWORD cbCertEncoded
- );
- //+-------------------------------------------------------------------------
- // Free a certificate context
- //
- // There needs to be a corresponding free for each context obtained by a
- // get, find, duplicate or create.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertFreeCertificateContext(
- IN PCCERT_CONTEXT pCertContext
- );
- //+-------------------------------------------------------------------------
- // Set the property for the specified certificate context.
- //
- // The type definition for pvData depends on the dwPropId value. There are
- // five predefined types:
- // CERT_KEY_PROV_HANDLE_PROP_ID - a HCRYPTPROV for the certificate's
- // private key is passed in pvData. Updates the hCryptProv field
- // of the CERT_KEY_CONTEXT_PROP_ID. If the CERT_KEY_CONTEXT_PROP_ID
- // doesn't exist, its created with all the other fields zeroed out. If
- // CERT_STORE_NO_CRYPT_RELEASE_FLAG isn't set, HCRYPTPROV is implicitly
- // released when either the property is set to NULL or on the final
- // free of the CertContext.
- //
- // CERT_KEY_PROV_INFO_PROP_ID - a PCRYPT_KEY_PROV_INFO for the certificate's
- // private key is passed in pvData.
- //
- // CERT_SHA1_HASH_PROP_ID -
- // CERT_MD5_HASH_PROP_ID -
- // CERT_SIGNATURE_HASH_PROP_ID - normally, a hash property is implicitly
- // set by doing a CertGetCertificateContextProperty. pvData points to a
- // CRYPT_HASH_BLOB.
- //
- // CERT_KEY_CONTEXT_PROP_ID - a PCERT_KEY_CONTEXT for the certificate's
- // private key is passed in pvData. The CERT_KEY_CONTEXT contains both the
- // hCryptProv and dwKeySpec for the private key.
- // See the CERT_KEY_PROV_HANDLE_PROP_ID for more information about
- // the hCryptProv field and dwFlags settings. Note, more fields may
- // be added for this property. The cbSize field value will be adjusted
- // accordingly.
- //
- // CERT_KEY_SPEC_PROP_ID - the dwKeySpec for the private key. pvData
- // points to a DWORD containing the KeySpec
- //
- // CERT_ENHKEY_USAGE_PROP_ID - enhanced key usage definition for the
- // certificate. pvData points to a CRYPT_DATA_BLOB containing an
- // ASN.1 encoded CERT_ENHKEY_USAGE (encoded via
- // CryptEncodeObject(X509_ENHANCED_KEY_USAGE).
- //
- // CERT_NEXT_UPDATE_LOCATION_PROP_ID - location of the next update.
- // Currently only applicable to CTLs. pvData points to a CRYPT_DATA_BLOB
- // containing an ASN.1 encoded CERT_ALT_NAME_INFO (encoded via
- // CryptEncodeObject(X509_ALTERNATE_NAME)).
- //
- // CERT_FRIENDLY_NAME_PROP_ID - friendly name for the cert, CRL or CTL.
- // pvData points to a CRYPT_DATA_BLOB. pbData is a pointer to a NULL
- // terminated unicode, wide character string.
- // cbData = (wcslen((LPWSTR) pbData) + 1) * sizeof(WCHAR).
- //
- // CERT_DESCRIPTION_PROP_ID - description for the cert, CRL or CTL.
- // pvData points to a CRYPT_DATA_BLOB. pbData is a pointer to a NULL
- // terminated unicode, wide character string.
- // cbData = (wcslen((LPWSTR) pbData) + 1) * sizeof(WCHAR).
- //
- // CERT_ARCHIVED_PROP_ID - when this property is set, the certificate
- // is skipped during enumeration. Note, certificates having this property
- // are still found for explicit finds, such as, finding a certificate
- // with a specific hash or finding a certificate having a specific issuer
- // and serial number. pvData points to a CRYPT_DATA_BLOB. This blob
- // can be NULL (pbData = NULL, cbData = 0).
- //
- // CERT_PUBKEY_ALG_PARA_PROP_ID - for public keys supporting
- // algorithm parameter inheritance. pvData points to a CRYPT_OBJID_BLOB
- // containing the ASN.1 encoded PublicKey Algorithm Parameters. For
- // DSS this would be the parameters encoded via
- // CryptEncodeObject(X509_DSS_PARAMETERS). This property may be set
- // by CryptVerifyCertificateSignatureEx().
- //
- // CERT_CROSS_CERT_DIST_POINTS_PROP_ID - location of the cross certs.
- // Currently only applicable to certs. pvData points to a CRYPT_DATA_BLOB
- // containing an ASN.1 encoded CROSS_CERT_DIST_POINTS_INFO (encoded via
- // CryptEncodeObject(X509_CROSS_CERT_DIST_POINTS)).
- //
- // CERT_ENROLLMENT_PROP_ID - enrollment information of the pending request.
- // It contains RequestID, CADNSName, CAName, and FriendlyName.
- // The data format is defined as, the first 4 bytes - pending request ID,
- // next 4 bytes - CADNSName size in characters including null-terminator
- // followed by CADNSName string with null-terminator,
- // next 4 bytes - CAName size in characters including null-terminator
- // followed by CAName string with null-terminator,
- // next 4 bytes - FriendlyName size in characters including null-terminator
- // followed by FriendlyName string with null-terminator.
- //
- // CERT_DATE_STAMP_PROP_ID - contains the time when added to the store
- // by an admin tool. pvData points to a CRYPT_DATA_BLOB containing
- // the FILETIME.
- //
- // CERT_RENEWAL_PROP_ID - contains the hash of renewed certificate
- //
- // For all the other PROP_IDs: an encoded PCRYPT_DATA_BLOB is passed in pvData.
- //
- // If the property already exists, then, the old value is deleted and silently
- // replaced. Setting, pvData to NULL, deletes the property.
- //
- // CERT_SET_PROPERTY_IGNORE_PERSIST_ERROR_FLAG can be set to ignore any
- // provider write errors and always update the cached context's property.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSetCertificateContextProperty(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN const void *pvData
- );
- // Set this flag to ignore any store provider write errors and always update
- // the cached context's property
- #define CERT_SET_PROPERTY_IGNORE_PERSIST_ERROR_FLAG 0x80000000
- // Set this flag to inhibit the persisting of this property
- #define CERT_SET_PROPERTY_INHIBIT_PERSIST_FLAG 0x40000000
- //+-------------------------------------------------------------------------
- // Get the property for the specified certificate context.
- //
- // For CERT_KEY_PROV_HANDLE_PROP_ID, pvData points to a HCRYPTPROV.
- //
- // For CERT_KEY_PROV_INFO_PROP_ID, pvData points to a CRYPT_KEY_PROV_INFO structure.
- // Elements pointed to by fields in the pvData structure follow the
- // structure. Therefore, *pcbData may exceed the size of the structure.
- //
- // For CERT_KEY_CONTEXT_PROP_ID, pvData points to a CERT_KEY_CONTEXT structure.
- //
- // For CERT_KEY_SPEC_PROP_ID, pvData points to a DWORD containing the KeySpec.
- // If the CERT_KEY_CONTEXT_PROP_ID exists, the KeySpec is obtained from there.
- // Otherwise, if the CERT_KEY_PROV_INFO_PROP_ID exists, its the source
- // of the KeySpec.
- //
- // For CERT_SHA1_HASH_PROP_ID or CERT_MD5_HASH_PROP_ID, if the hash
- // doesn't already exist, then, its computed via CryptHashCertificate()
- // and then set. pvData points to the computed hash. Normally, the length
- // is 20 bytes for SHA and 16 for MD5.
- //
- // For CERT_SIGNATURE_HASH_PROP_ID, if the hash
- // doesn't already exist, then, its computed via CryptHashToBeSigned()
- // and then set. pvData points to the computed hash. Normally, the length
- // is 20 bytes for SHA and 16 for MD5.
- //
- // For CERT_ACCESS_STATE_PROP_ID, pvData points to a DWORD containing the
- // access state flags. The appropriate CERT_ACCESS_STATE_*_FLAG's are set
- // in the returned DWORD. See the CERT_ACCESS_STATE_*_FLAG definitions
- // above. Note, this property is read only. It can't be set.
- //
- // For CERT_KEY_IDENTIFIER_PROP_ID, if property doesn't already exist,
- // first searches for the szOID_SUBJECT_KEY_IDENTIFIER extension. Next,
- // does SHA1 hash of the certficate's SubjectPublicKeyInfo. pvData
- // points to the key identifier bytes. Normally, the length is 20 bytes.
- //
- // For CERT_PUBKEY_ALG_PARA_PROP_ID, pvPara points to the ASN.1 encoded
- // PublicKey Algorithm Parameters. This property will only be set
- // for public keys supporting algorithm parameter inheritance and when the
- // parameters have been omitted from the encoded and signed certificate.
- //
- // For CERT_DATE_STAMP_PROP_ID, pvPara points to a FILETIME updated by
- // an admin tool to indicate when the certificate was added to the store.
- //
- // For all other PROP_IDs, pvData points to an encoded array of bytes.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetCertificateContextProperty(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwPropId,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- //+-------------------------------------------------------------------------
- // Enumerate the properties for the specified certificate context.
- //
- // To get the first property, set dwPropId to 0. The ID of the first
- // property is returned. To get the next property, set dwPropId to the
- // ID returned by the last call. To enumerate all the properties continue
- // until 0 is returned.
- //
- // CertGetCertificateContextProperty is called to get the property's data.
- //
- // Note, since, the CERT_KEY_PROV_HANDLE_PROP_ID and CERT_KEY_SPEC_PROP_ID
- // properties are stored as fields in the CERT_KEY_CONTEXT_PROP_ID
- // property, they aren't enumerated individually.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertEnumCertificateContextProperties(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwPropId
- );
- //+-------------------------------------------------------------------------
- // Creates a CTL entry whose attributes are the certificate context's
- // properties.
- //
- // The SubjectIdentifier in the CTL entry is the SHA1 hash of the certificate.
- //
- // The certificate properties are added as attributes. The property attribute
- // OID is the decimal PROP_ID preceded by szOID_CERT_PROP_ID_PREFIX. Each
- // property value is copied as a single attribute value.
- //
- // Any additional attributes to be included in the CTL entry can be passed
- // in via the cOptAttr and rgOptAttr parameters.
- //
- // CTL_ENTRY_FROM_PROP_CHAIN_FLAG can be set in dwFlags, to force the
- // inclusion of the chain building hash properties as attributes.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertCreateCTLEntryFromCertificateContextProperties(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD cOptAttr,
- IN OPTIONAL PCRYPT_ATTRIBUTE rgOptAttr,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved,
- OUT OPTIONAL PCTL_ENTRY pCtlEntry,
- IN OUT DWORD *pcbCtlEntry
- );
- // Set this flag to get and include the chain building hash properties
- // as attributes in the CTL entry
- #define CTL_ENTRY_FROM_PROP_CHAIN_FLAG 0x1
- //+-------------------------------------------------------------------------
- // Sets properties on the certificate context using the attributes in
- // the CTL entry.
- //
- // The property attribute OID is the decimal PROP_ID preceded by
- // szOID_CERT_PROP_ID_PREFIX. Only attributes containing such an OID are
- // copied.
- //
- // CERT_SET_PROPERTY_IGNORE_PERSIST_ERROR_FLAG may be set in dwFlags.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSetCertificateContextPropertiesFromCTLEntry(
- IN PCCERT_CONTEXT pCertContext,
- IN PCTL_ENTRY pCtlEntry,
- IN DWORD dwFlags
- );
- //+-------------------------------------------------------------------------
- // Get the first or next CRL context from the store for the specified
- // issuer certificate. Perform the enabled verification checks on the CRL.
- //
- // If the first or next CRL isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CRL_CONTEXT is returned. CRL_CONTEXT
- // must be freed by calling CertFreeCRLContext. However, the free must be
- // pPrevCrlContext on a subsequent call. CertDuplicateCRLContext
- // can be called to make a duplicate.
- //
- // The pIssuerContext may have been obtained from this store, another store
- // or created by the caller application. When created by the caller, the
- // CertCreateCertificateContext function must have been called.
- //
- // If pIssuerContext == NULL, finds all the CRLs in the store.
- //
- // An issuer may have multiple CRLs. For example, it generates delta CRLs
- // using a X.509 v3 extension. pPrevCrlContext MUST BE NULL on the first
- // call to get the CRL. To get the next CRL for the issuer, the
- // pPrevCrlContext is set to the CRL_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevCrlContext is always CertFreeCRLContext'ed by
- // this function, even for an error.
- //
- // The following flags can be set in *pdwFlags to enable verification checks
- // on the returned CRL:
- // CERT_STORE_SIGNATURE_FLAG - use the public key in the
- // issuer's certificate to verify the
- // signature on the returned CRL.
- // Note, if pIssuerContext->hCertStore ==
- // hCertStore, the store provider might
- // be able to eliminate a redo of
- // the signature verify.
- // CERT_STORE_TIME_VALIDITY_FLAG - get the current time and verify that
- // its within the CRL's ThisUpdate and
- // NextUpdate validity period.
- // CERT_STORE_BASE_CRL_FLAG - get base CRL.
- // CERT_STORE_DELTA_CRL_FLAG - get delta CRL.
- //
- // If only one of CERT_STORE_BASE_CRL_FLAG or CERT_STORE_DELTA_CRL_FLAG is
- // set, then, only returns either a base or delta CRL. In any case, the
- // appropriate base or delta flag will be cleared upon returned. If both
- // flags are set, then, only one of flags will be cleared.
- //
- // If an enabled verification check fails, then, its flag is set upon return.
- //
- // If pIssuerContext == NULL, then, an enabled CERT_STORE_SIGNATURE_FLAG
- // always fails and the CERT_STORE_NO_ISSUER_FLAG is also set.
- //
- // For a verification check failure, a pointer to the first or next
- // CRL_CONTEXT is still returned and SetLastError isn't updated.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCRL_CONTEXT
- WINAPI
- CertGetCRLFromStore(
- IN HCERTSTORE hCertStore,
- IN OPTIONAL PCCERT_CONTEXT pIssuerContext,
- IN PCCRL_CONTEXT pPrevCrlContext,
- IN OUT DWORD *pdwFlags
- );
- //+-------------------------------------------------------------------------
- // Enumerate the CRL contexts in the store.
- //
- // If a CRL isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CRL_CONTEXT is returned. CRL_CONTEXT
- // must be freed by calling CertFreeCRLContext or is freed when passed as the
- // pPrevCrlContext on a subsequent call. CertDuplicateCRLContext
- // can be called to make a duplicate.
- //
- // pPrevCrlContext MUST BE NULL to enumerate the first
- // CRL in the store. Successive CRLs are enumerated by setting
- // pPrevCrlContext to the CRL_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevCrlContext is always CertFreeCRLContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCRL_CONTEXT
- WINAPI
- CertEnumCRLsInStore(
- IN HCERTSTORE hCertStore,
- IN PCCRL_CONTEXT pPrevCrlContext
- );
- //+-------------------------------------------------------------------------
- // Find the first or next CRL context in the store.
- //
- // The CRL is found according to the dwFindType and its pvFindPara.
- // See below for a list of the find types and its parameters.
- //
- // Currently dwFindFlags isn't used and must be set to 0.
- //
- // Usage of dwCertEncodingType depends on the dwFindType.
- //
- // If the first or next CRL isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CRL_CONTEXT is returned. CRL_CONTEXT
- // must be freed by calling CertFreeCRLContext or is freed when passed as the
- // pPrevCrlContext on a subsequent call. CertDuplicateCRLContext
- // can be called to make a duplicate.
- //
- // pPrevCrlContext MUST BE NULL on the first
- // call to find the CRL. To find the next CRL, the
- // pPrevCrlContext is set to the CRL_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevCrlContext is always CertFreeCRLContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCRL_CONTEXT
- WINAPI
- CertFindCRLInStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwCertEncodingType,
- IN DWORD dwFindFlags,
- IN DWORD dwFindType,
- IN const void *pvFindPara,
- IN PCCRL_CONTEXT pPrevCrlContext
- );
- #define CRL_FIND_ANY 0
- #define CRL_FIND_ISSUED_BY 1
- #define CRL_FIND_EXISTING 2
- #define CRL_FIND_ISSUED_FOR 3
- //+-------------------------------------------------------------------------
- // CRL_FIND_ANY
- //
- // Find any CRL.
- //
- // pvFindPara isn't used.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CRL_FIND_ISSUED_BY
- //
- // Find CRL matching the specified issuer.
- //
- // pvFindPara is the PCCERT_CONTEXT of the CRL issuer. May be NULL to
- // match any issuer.
- //
- // By default, only does issuer name matching. The following flags can be
- // set in dwFindFlags to do additional filtering.
- //
- // If CRL_FIND_ISSUED_BY_AKI_FLAG is set in dwFindFlags, then, checks if the
- // CRL has an Authority Key Identifier (AKI) extension. If the CRL has an
- // AKI, then, only returns a CRL whose AKI matches the issuer.
- //
- // Note, the AKI extension has the following OID:
- // szOID_AUTHORITY_KEY_IDENTIFIER2 and its corresponding data structure.
- //
- // If CRL_FIND_ISSUED_BY_SIGNATURE_FLAG is set in dwFindFlags, then,
- // uses the public key in the issuer's certificate to verify the
- // signature on the CRL. Only returns a CRL having a valid signature.
- //
- // If CRL_FIND_ISSUED_BY_DELTA_FLAG is set in dwFindFlags, then, only
- // returns a delta CRL.
- //
- // If CRL_FIND_ISSUED_BY_BASE_FLAG is set in dwFindFlags, then, only
- // returns a base CRL.
- //--------------------------------------------------------------------------
- #define CRL_FIND_ISSUED_BY_AKI_FLAG 0x1
- #define CRL_FIND_ISSUED_BY_SIGNATURE_FLAG 0x2
- #define CRL_FIND_ISSUED_BY_DELTA_FLAG 0x4
- #define CRL_FIND_ISSUED_BY_BASE_FLAG 0x8
- //+-------------------------------------------------------------------------
- // CRL_FIND_EXISTING
- //
- // Find existing CRL in the store.
- //
- // pvFindPara is the PCCRL_CONTEXT of the CRL to check if it already
- // exists in the store.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CRL_FIND_ISSUED_FOR
- //
- // Find CRL for the specified subject and its issuer.
- //
- // pvFindPara points to the following CRL_FIND_ISSUED_FOR_PARA which contains
- // both the subject and issuer certificates. Not optional.
- //
- // The subject's issuer name is used to match the CRL's issuer name. Otherwise,
- // the issuer's certificate is used the same as in the above
- // CRL_FIND_ISSUED_BY.
- //
- // Note, when cross certificates are used, the subject name in the issuer's
- // certificate may not match the issuer name in the subject certificate and
- // its corresponding CRL.
- //
- // All of the above CRL_FIND_ISSUED_BY_*_FLAGS apply to this find type.
- //--------------------------------------------------------------------------
- typedef struct _CRL_FIND_ISSUED_FOR_PARA {
- PCCERT_CONTEXT pSubjectCert;
- PCCERT_CONTEXT pIssuerCert;
- } CRL_FIND_ISSUED_FOR_PARA, *PCRL_FIND_ISSUED_FOR_PARA;
- //+-------------------------------------------------------------------------
- // Duplicate a CRL context
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCRL_CONTEXT
- WINAPI
- CertDuplicateCRLContext(
- IN PCCRL_CONTEXT pCrlContext
- );
- //+-------------------------------------------------------------------------
- // Create a CRL context from the encoded CRL. The created
- // context isn't put in a store.
- //
- // Makes a copy of the encoded CRL in the created context.
- //
- // If unable to decode and create the CRL context, NULL is returned.
- // Otherwise, a pointer to a read only CRL_CONTEXT is returned.
- // CRL_CONTEXT must be freed by calling CertFreeCRLContext.
- // CertDuplicateCRLContext can be called to make a duplicate.
- //
- // CertSetCRLContextProperty and CertGetCRLContextProperty can be called
- // to store properties for the CRL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCRL_CONTEXT
- WINAPI
- CertCreateCRLContext(
- IN DWORD dwCertEncodingType,
- IN const BYTE *pbCrlEncoded,
- IN DWORD cbCrlEncoded
- );
- //+-------------------------------------------------------------------------
- // Free a CRL context
- //
- // There needs to be a corresponding free for each context obtained by a
- // get, duplicate or create.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertFreeCRLContext(
- IN PCCRL_CONTEXT pCrlContext
- );
- //+-------------------------------------------------------------------------
- // Set the property for the specified CRL context.
- //
- // Same Property Ids and semantics as CertSetCertificateContextProperty.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSetCRLContextProperty(
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN const void *pvData
- );
- //+-------------------------------------------------------------------------
- // Get the property for the specified CRL context.
- //
- // Same Property Ids and semantics as CertGetCertificateContextProperty.
- //
- // CERT_SHA1_HASH_PROP_ID, CERT_MD5_HASH_PROP_ID or
- // CERT_SIGNATURE_HASH_PROP_ID is the predefined property of most interest.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetCRLContextProperty(
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwPropId,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- //+-------------------------------------------------------------------------
- // Enumerate the properties for the specified CRL context.
- //
- // To get the first property, set dwPropId to 0. The ID of the first
- // property is returned. To get the next property, set dwPropId to the
- // ID returned by the last call. To enumerate all the properties continue
- // until 0 is returned.
- //
- // CertGetCRLContextProperty is called to get the property's data.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertEnumCRLContextProperties(
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwPropId
- );
- //+-------------------------------------------------------------------------
- // Search the CRL's list of entries for the specified certificate.
- //
- // TRUE is returned if we were able to search the list. Otherwise, FALSE is
- // returned,
- //
- // For success, if the certificate was found in the list, *ppCrlEntry is
- // updated with a pointer to the entry. Otherwise, *ppCrlEntry is set to NULL.
- // The returned entry isn't allocated and must not be freed.
- //
- // dwFlags and pvReserved currently aren't used and must be set to 0 or NULL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertFindCertificateInCRL(
- IN PCCERT_CONTEXT pCert,
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved,
- OUT PCRL_ENTRY *ppCrlEntry
- );
- //+-------------------------------------------------------------------------
- // Is the specified CRL valid for the certificate.
- //
- // Returns TRUE if the CRL's list of entries would contain the certificate
- // if it was revoked. Note, doesn't check that the certificate is in the
- // list of entries.
- //
- // If the CRL has an Issuing Distribution Point (IDP) extension, checks
- // that it's valid for the subject certificate.
- //
- // dwFlags and pvReserved currently aren't used and must be set to 0 and NULL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertIsValidCRLForCertificate(
- IN PCCERT_CONTEXT pCert,
- IN PCCRL_CONTEXT pCrl,
- IN DWORD dwFlags,
- IN void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // Add certificate/CRL, encoded, context or element disposition values.
- //--------------------------------------------------------------------------
- #define CERT_STORE_ADD_NEW 1
- #define CERT_STORE_ADD_USE_EXISTING 2
- #define CERT_STORE_ADD_REPLACE_EXISTING 3
- #define CERT_STORE_ADD_ALWAYS 4
- #define CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES 5
- #define CERT_STORE_ADD_NEWER 6
- #define CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES 7
- //+-------------------------------------------------------------------------
- // Add the encoded certificate to the store according to the specified
- // disposition action.
- //
- // Makes a copy of the encoded certificate before adding to the store.
- //
- // dwAddDispostion specifies the action to take if the certificate
- // already exists in the store. This parameter must be one of the following
- // values:
- // CERT_STORE_ADD_NEW
- // Fails if the certificate already exists in the store. LastError
- // is set to CRYPT_E_EXISTS.
- // CERT_STORE_ADD_USE_EXISTING
- // If the certifcate already exists, then, its used and if ppCertContext
- // is non-NULL, the existing context is duplicated.
- // CERT_STORE_ADD_REPLACE_EXISTING
- // If the certificate already exists, then, the existing certificate
- // context is deleted before creating and adding the new context.
- // CERT_STORE_ADD_ALWAYS
- // No check is made to see if the certificate already exists. A
- // new certificate context is always created. This may lead to
- // duplicates in the store.
- // CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES
- // If the certificate already exists, then, its used.
- // CERT_STORE_ADD_NEWER
- // Fails if the certificate already exists in the store AND the NotBefore
- // time of the existing certificate is equal to or greater than the
- // NotBefore time of the new certificate being added. LastError
- // is set to CRYPT_E_EXISTS.
- //
- // If an older certificate is replaced, same as
- // CERT_STORE_ADD_REPLACE_EXISTING.
- //
- // For CRLs or CTLs compares the ThisUpdate times.
- //
- // CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES
- // Same as CERT_STORE_ADD_NEWER. However, if an older certificate is
- // replaced, same as CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES.
- //
- // CertGetSubjectCertificateFromStore is called to determine if the
- // certificate already exists in the store.
- //
- // ppCertContext can be NULL, indicating the caller isn't interested
- // in getting the CERT_CONTEXT of the added or existing certificate.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddEncodedCertificateToStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwCertEncodingType,
- IN const BYTE *pbCertEncoded,
- IN DWORD cbCertEncoded,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCERT_CONTEXT *ppCertContext
- );
- //+-------------------------------------------------------------------------
- // Add the certificate context to the store according to the specified
- // disposition action.
- //
- // In addition to the encoded certificate, the context's properties are
- // also copied. Note, the CERT_KEY_CONTEXT_PROP_ID property (and its
- // CERT_KEY_PROV_HANDLE_PROP_ID or CERT_KEY_SPEC_PROP_ID) isn't copied.
- //
- // Makes a copy of the certificate context before adding to the store.
- //
- // dwAddDispostion specifies the action to take if the certificate
- // already exists in the store. This parameter must be one of the following
- // values:
- // CERT_STORE_ADD_NEW
- // Fails if the certificate already exists in the store. LastError
- // is set to CRYPT_E_EXISTS.
- // CERT_STORE_ADD_USE_EXISTING
- // If the certifcate already exists, then, its used and if ppStoreContext
- // is non-NULL, the existing context is duplicated. Iterates
- // through pCertContext's properties and only copies the properties
- // that don't already exist. The SHA1 and MD5 hash properties aren't
- // copied.
- // CERT_STORE_ADD_REPLACE_EXISTING
- // If the certificate already exists, then, the existing certificate
- // context is deleted before creating and adding a new context.
- // Properties are copied before doing the add.
- // CERT_STORE_ADD_ALWAYS
- // No check is made to see if the certificate already exists. A
- // new certificate context is always created and added. This may lead to
- // duplicates in the store. Properties are
- // copied before doing the add.
- // CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES
- // If the certificate already exists, then, the existing certificate
- // context is used. Properties from the added context are copied and
- // replace existing properties. However, any existing properties not
- // in the added context remain and aren't deleted.
- // CERT_STORE_ADD_NEWER
- // Fails if the certificate already exists in the store AND the NotBefore
- // time of the existing context is equal to or greater than the
- // NotBefore time of the new context being added. LastError
- // is set to CRYPT_E_EXISTS.
- //
- // If an older context is replaced, same as
- // CERT_STORE_ADD_REPLACE_EXISTING.
- //
- // For CRLs or CTLs compares the ThisUpdate times.
- //
- // CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES
- // Same as CERT_STORE_ADD_NEWER. However, if an older context is
- // replaced, same as CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES.
- //
- // CertGetSubjectCertificateFromStore is called to determine if the
- // certificate already exists in the store.
- //
- // ppStoreContext can be NULL, indicating the caller isn't interested
- // in getting the CERT_CONTEXT of the added or existing certificate.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddCertificateContextToStore(
- IN HCERTSTORE hCertStore,
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCERT_CONTEXT *ppStoreContext
- );
- //+-------------------------------------------------------------------------
- // Certificate Store Context Types
- //--------------------------------------------------------------------------
- #define CERT_STORE_CERTIFICATE_CONTEXT 1
- #define CERT_STORE_CRL_CONTEXT 2
- #define CERT_STORE_CTL_CONTEXT 3
- //+-------------------------------------------------------------------------
- // Certificate Store Context Bit Flags
- //--------------------------------------------------------------------------
- #define CERT_STORE_ALL_CONTEXT_FLAG (~0UL)
- #define CERT_STORE_CERTIFICATE_CONTEXT_FLAG \
- (1 << CERT_STORE_CERTIFICATE_CONTEXT)
- #define CERT_STORE_CRL_CONTEXT_FLAG \
- (1 << CERT_STORE_CRL_CONTEXT)
- #define CERT_STORE_CTL_CONTEXT_FLAG \
- (1 << CERT_STORE_CTL_CONTEXT)
- //+-------------------------------------------------------------------------
- // Add the serialized certificate or CRL element to the store.
- //
- // The serialized element contains the encoded certificate, CRL or CTL and
- // its properties, such as, CERT_KEY_PROV_INFO_PROP_ID.
- //
- // If hCertStore is NULL, creates a certificate, CRL or CTL context not
- // residing in any store.
- //
- // dwAddDispostion specifies the action to take if the certificate or CRL
- // already exists in the store. See CertAddCertificateContextToStore for a
- // list of and actions taken.
- //
- // dwFlags currently isn't used and should be set to 0.
- //
- // dwContextTypeFlags specifies the set of allowable contexts. For example, to
- // add either a certificate or CRL, set dwContextTypeFlags to:
- // CERT_STORE_CERTIFICATE_CONTEXT_FLAG | CERT_STORE_CRL_CONTEXT_FLAG
- //
- // *pdwContextType is updated with the type of the context returned in
- // *ppvContxt. pdwContextType or ppvContext can be NULL, indicating the
- // caller isn't interested in getting the output. If *ppvContext is
- // returned it must be freed by calling CertFreeCertificateContext or
- // CertFreeCRLContext.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddSerializedElementToStore(
- IN HCERTSTORE hCertStore,
- IN const BYTE *pbElement,
- IN DWORD cbElement,
- IN DWORD dwAddDisposition,
- IN DWORD dwFlags,
- IN DWORD dwContextTypeFlags,
- OUT OPTIONAL DWORD *pdwContextType,
- OUT OPTIONAL const void **ppvContext
- );
- //+-------------------------------------------------------------------------
- // Delete the specified certificate from the store.
- //
- // All subsequent gets or finds for the certificate will fail. However,
- // memory allocated for the certificate isn't freed until all of its contexts
- // have also been freed.
- //
- // The pCertContext is obtained from a get, enum, find or duplicate.
- //
- // Some store provider implementations might also delete the issuer's CRLs
- // if this is the last certificate for the issuer in the store.
- //
- // NOTE: the pCertContext is always CertFreeCertificateContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertDeleteCertificateFromStore(
- IN PCCERT_CONTEXT pCertContext
- );
- //+-------------------------------------------------------------------------
- // Add the encoded CRL to the store according to the specified
- // disposition option.
- //
- // Makes a copy of the encoded CRL before adding to the store.
- //
- // dwAddDispostion specifies the action to take if the CRL
- // already exists in the store. See CertAddEncodedCertificateToStore for a
- // list of and actions taken.
- //
- // Compares the CRL's Issuer to determine if the CRL already exists in the
- // store.
- //
- // ppCrlContext can be NULL, indicating the caller isn't interested
- // in getting the CRL_CONTEXT of the added or existing CRL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddEncodedCRLToStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwCertEncodingType,
- IN const BYTE *pbCrlEncoded,
- IN DWORD cbCrlEncoded,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCRL_CONTEXT *ppCrlContext
- );
- //+-------------------------------------------------------------------------
- // Add the CRL context to the store according to the specified
- // disposition option.
- //
- // In addition to the encoded CRL, the context's properties are
- // also copied. Note, the CERT_KEY_CONTEXT_PROP_ID property (and its
- // CERT_KEY_PROV_HANDLE_PROP_ID or CERT_KEY_SPEC_PROP_ID) isn't copied.
- //
- // Makes a copy of the encoded CRL before adding to the store.
- //
- // dwAddDispostion specifies the action to take if the CRL
- // already exists in the store. See CertAddCertificateContextToStore for a
- // list of and actions taken.
- //
- // Compares the CRL's Issuer, ThisUpdate and NextUpdate to determine
- // if the CRL already exists in the store.
- //
- // ppStoreContext can be NULL, indicating the caller isn't interested
- // in getting the CRL_CONTEXT of the added or existing CRL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddCRLContextToStore(
- IN HCERTSTORE hCertStore,
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCRL_CONTEXT *ppStoreContext
- );
- //+-------------------------------------------------------------------------
- // Delete the specified CRL from the store.
- //
- // All subsequent gets for the CRL will fail. However,
- // memory allocated for the CRL isn't freed until all of its contexts
- // have also been freed.
- //
- // The pCrlContext is obtained from a get or duplicate.
- //
- // NOTE: the pCrlContext is always CertFreeCRLContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertDeleteCRLFromStore(
- IN PCCRL_CONTEXT pCrlContext
- );
- //+-------------------------------------------------------------------------
- // Serialize the certificate context's encoded certificate and its
- // properties.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSerializeCertificateStoreElement(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwFlags,
- OUT BYTE *pbElement,
- IN OUT DWORD *pcbElement
- );
- //+-------------------------------------------------------------------------
- // Serialize the CRL context's encoded CRL and its properties.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSerializeCRLStoreElement(
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwFlags,
- OUT BYTE *pbElement,
- IN OUT DWORD *pcbElement
- );
- //+=========================================================================
- // Certificate Trust List (CTL) Store Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Duplicate a CTL context
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCTL_CONTEXT
- WINAPI
- CertDuplicateCTLContext(
- IN PCCTL_CONTEXT pCtlContext
- );
- //+-------------------------------------------------------------------------
- // Create a CTL context from the encoded CTL. The created
- // context isn't put in a store.
- //
- // Makes a copy of the encoded CTL in the created context.
- //
- // If unable to decode and create the CTL context, NULL is returned.
- // Otherwise, a pointer to a read only CTL_CONTEXT is returned.
- // CTL_CONTEXT must be freed by calling CertFreeCTLContext.
- // CertDuplicateCTLContext can be called to make a duplicate.
- //
- // CertSetCTLContextProperty and CertGetCTLContextProperty can be called
- // to store properties for the CTL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCTL_CONTEXT
- WINAPI
- CertCreateCTLContext(
- IN DWORD dwMsgAndCertEncodingType,
- IN const BYTE *pbCtlEncoded,
- IN DWORD cbCtlEncoded
- );
- //+-------------------------------------------------------------------------
- // Free a CTL context
- //
- // There needs to be a corresponding free for each context obtained by a
- // get, duplicate or create.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertFreeCTLContext(
- IN PCCTL_CONTEXT pCtlContext
- );
- //+-------------------------------------------------------------------------
- // Set the property for the specified CTL context.
- //
- // Same Property Ids and semantics as CertSetCertificateContextProperty.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSetCTLContextProperty(
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN const void *pvData
- );
- //+-------------------------------------------------------------------------
- // Get the property for the specified CTL context.
- //
- // Same Property Ids and semantics as CertGetCertificateContextProperty.
- //
- // CERT_SHA1_HASH_PROP_ID or CERT_NEXT_UPDATE_LOCATION_PROP_ID are the
- // predefined properties of most interest.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetCTLContextProperty(
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwPropId,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- //+-------------------------------------------------------------------------
- // Enumerate the properties for the specified CTL context.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertEnumCTLContextProperties(
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwPropId
- );
- //+-------------------------------------------------------------------------
- // Enumerate the CTL contexts in the store.
- //
- // If a CTL isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CTL_CONTEXT is returned. CTL_CONTEXT
- // must be freed by calling CertFreeCTLContext or is freed when passed as the
- // pPrevCtlContext on a subsequent call. CertDuplicateCTLContext
- // can be called to make a duplicate.
- //
- // pPrevCtlContext MUST BE NULL to enumerate the first
- // CTL in the store. Successive CTLs are enumerated by setting
- // pPrevCtlContext to the CTL_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevCtlContext is always CertFreeCTLContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCTL_CONTEXT
- WINAPI
- CertEnumCTLsInStore(
- IN HCERTSTORE hCertStore,
- IN PCCTL_CONTEXT pPrevCtlContext
- );
- //+-------------------------------------------------------------------------
- // Attempt to find the specified subject in the CTL.
- //
- // For CTL_CERT_SUBJECT_TYPE, pvSubject points to a CERT_CONTEXT. The CTL's
- // SubjectAlgorithm is examined to determine the representation of the
- // subject's identity. Initially, only SHA1 or MD5 hash will be supported.
- // The appropriate hash property is obtained from the CERT_CONTEXT.
- //
- // For CTL_ANY_SUBJECT_TYPE, pvSubject points to the CTL_ANY_SUBJECT_INFO
- // structure which contains the SubjectAlgorithm to be matched in the CTL
- // and the SubjectIdentifer to be matched in one of the CTL entries.
- //
- // The certificate's hash or the CTL_ANY_SUBJECT_INFO's SubjectIdentifier
- // is used as the key in searching the subject entries. A binary
- // memory comparison is done between the key and the entry's SubjectIdentifer.
- //
- // dwEncodingType isn't used for either of the above SubjectTypes.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCTL_ENTRY
- WINAPI
- CertFindSubjectInCTL(
- IN DWORD dwEncodingType,
- IN DWORD dwSubjectType,
- IN void *pvSubject,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwFlags
- );
- // Subject Types:
- // CTL_ANY_SUBJECT_TYPE, pvSubject points to following CTL_ANY_SUBJECT_INFO.
- // CTL_CERT_SUBJECT_TYPE, pvSubject points to CERT_CONTEXT.
- #define CTL_ANY_SUBJECT_TYPE 1
- #define CTL_CERT_SUBJECT_TYPE 2
- typedef struct _CTL_ANY_SUBJECT_INFO {
- CRYPT_ALGORITHM_IDENTIFIER SubjectAlgorithm;
- CRYPT_DATA_BLOB SubjectIdentifier;
- } CTL_ANY_SUBJECT_INFO, *PCTL_ANY_SUBJECT_INFO;
- //+-------------------------------------------------------------------------
- // Find the first or next CTL context in the store.
- //
- // The CTL is found according to the dwFindType and its pvFindPara.
- // See below for a list of the find types and its parameters.
- //
- // Currently dwFindFlags isn't used and must be set to 0.
- //
- // Usage of dwMsgAndCertEncodingType depends on the dwFindType.
- //
- // If the first or next CTL isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CTL_CONTEXT is returned. CTL_CONTEXT
- // must be freed by calling CertFreeCTLContext or is freed when passed as the
- // pPrevCtlContext on a subsequent call. CertDuplicateCTLContext
- // can be called to make a duplicate.
- //
- // pPrevCtlContext MUST BE NULL on the first
- // call to find the CTL. To find the next CTL, the
- // pPrevCtlContext is set to the CTL_CONTEXT returned by a previous call.
- //
- // NOTE: a NON-NULL pPrevCtlContext is always CertFreeCTLContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCTL_CONTEXT
- WINAPI
- CertFindCTLInStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwMsgAndCertEncodingType,
- IN DWORD dwFindFlags,
- IN DWORD dwFindType,
- IN const void *pvFindPara,
- IN PCCTL_CONTEXT pPrevCtlContext
- );
- #define CTL_FIND_ANY 0
- #define CTL_FIND_SHA1_HASH 1
- #define CTL_FIND_MD5_HASH 2
- #define CTL_FIND_USAGE 3
- #define CTL_FIND_SUBJECT 4
- #define CTL_FIND_EXISTING 5
- typedef struct _CTL_FIND_USAGE_PARA {
- DWORD cbSize;
- CTL_USAGE SubjectUsage; // optional
- CRYPT_DATA_BLOB ListIdentifier; // optional
- PCERT_INFO pSigner; // optional
- } CTL_FIND_USAGE_PARA, *PCTL_FIND_USAGE_PARA;
- #define CTL_FIND_NO_LIST_ID_CBDATA 0xFFFFFFFF
- #define CTL_FIND_NO_SIGNER_PTR ((PCERT_INFO) -1)
- #define CTL_FIND_SAME_USAGE_FLAG 0x1
- typedef struct _CTL_FIND_SUBJECT_PARA {
- DWORD cbSize;
- PCTL_FIND_USAGE_PARA pUsagePara; // optional
- DWORD dwSubjectType;
- void *pvSubject;
- } CTL_FIND_SUBJECT_PARA, *PCTL_FIND_SUBJECT_PARA;
- //+-------------------------------------------------------------------------
- // CTL_FIND_ANY
- //
- // Find any CTL.
- //
- // pvFindPara isn't used.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CTL_FIND_SHA1_HASH
- // CTL_FIND_MD5_HASH
- //
- // Find a CTL with the specified hash.
- //
- // pvFindPara points to a CRYPT_HASH_BLOB.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CTL_FIND_USAGE
- //
- // Find a CTL having the specified usage identifiers, list identifier or
- // signer. The CertEncodingType of the signer is obtained from the
- // dwMsgAndCertEncodingType parameter.
- //
- // pvFindPara points to a CTL_FIND_USAGE_PARA data structure. The
- // SubjectUsage.cUsageIdentifer can be 0 to match any usage. The
- // ListIdentifier.cbData can be 0 to match any list identifier. To only match
- // CTLs without a ListIdentifier, cbData must be set to
- // CTL_FIND_NO_LIST_ID_CBDATA. pSigner can be NULL to match any signer. Only
- // the Issuer and SerialNumber fields of the pSigner's PCERT_INFO are used.
- // To only match CTLs without a signer, pSigner must be set to
- // CTL_FIND_NO_SIGNER_PTR.
- //
- // The CTL_FIND_SAME_USAGE_FLAG can be set in dwFindFlags to
- // only match CTLs with the same usage identifiers. CTLs having additional
- // usage identifiers aren't matched. For example, if only "1.2.3" is specified
- // in CTL_FIND_USAGE_PARA, then, for a match, the CTL must only contain
- // "1.2.3" and not any additional usage identifers.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CTL_FIND_SUBJECT
- //
- // Find a CTL having the specified subject. CertFindSubjectInCTL can be
- // called to get a pointer to the subject's entry in the CTL. pUsagePara can
- // optionally be set to enable the above CTL_FIND_USAGE matching.
- //
- // pvFindPara points to a CTL_FIND_SUBJECT_PARA data structure.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Add the encoded CTL to the store according to the specified
- // disposition option.
- //
- // Makes a copy of the encoded CTL before adding to the store.
- //
- // dwAddDispostion specifies the action to take if the CTL
- // already exists in the store. See CertAddEncodedCertificateToStore for a
- // list of and actions taken.
- //
- // Compares the CTL's SubjectUsage, ListIdentifier and any of its signers
- // to determine if the CTL already exists in the store.
- //
- // ppCtlContext can be NULL, indicating the caller isn't interested
- // in getting the CTL_CONTEXT of the added or existing CTL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddEncodedCTLToStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwMsgAndCertEncodingType,
- IN const BYTE *pbCtlEncoded,
- IN DWORD cbCtlEncoded,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCTL_CONTEXT *ppCtlContext
- );
- //+-------------------------------------------------------------------------
- // Add the CTL context to the store according to the specified
- // disposition option.
- //
- // In addition to the encoded CTL, the context's properties are
- // also copied. Note, the CERT_KEY_CONTEXT_PROP_ID property (and its
- // CERT_KEY_PROV_HANDLE_PROP_ID or CERT_KEY_SPEC_PROP_ID) isn't copied.
- //
- // Makes a copy of the encoded CTL before adding to the store.
- //
- // dwAddDispostion specifies the action to take if the CTL
- // already exists in the store. See CertAddCertificateContextToStore for a
- // list of and actions taken.
- //
- // Compares the CTL's SubjectUsage, ListIdentifier and any of its signers
- // to determine if the CTL already exists in the store.
- //
- // ppStoreContext can be NULL, indicating the caller isn't interested
- // in getting the CTL_CONTEXT of the added or existing CTL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddCTLContextToStore(
- IN HCERTSTORE hCertStore,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCTL_CONTEXT *ppStoreContext
- );
- //+-------------------------------------------------------------------------
- // Serialize the CTL context's encoded CTL and its properties.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSerializeCTLStoreElement(
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwFlags,
- OUT BYTE *pbElement,
- IN OUT DWORD *pcbElement
- );
- //+-------------------------------------------------------------------------
- // Delete the specified CTL from the store.
- //
- // All subsequent gets for the CTL will fail. However,
- // memory allocated for the CTL isn't freed until all of its contexts
- // have also been freed.
- //
- // The pCtlContext is obtained from a get or duplicate.
- //
- // NOTE: the pCtlContext is always CertFreeCTLContext'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertDeleteCTLFromStore(
- IN PCCTL_CONTEXT pCtlContext
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddCertificateLinkToStore(
- IN HCERTSTORE hCertStore,
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCERT_CONTEXT *ppStoreContext
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddCRLLinkToStore(
- IN HCERTSTORE hCertStore,
- IN PCCRL_CONTEXT pCrlContext,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCRL_CONTEXT *ppStoreContext
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddCTLLinkToStore(
- IN HCERTSTORE hCertStore,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwAddDisposition,
- OUT OPTIONAL PCCTL_CONTEXT *ppStoreContext
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddStoreToCollection(
- IN HCERTSTORE hCollectionStore,
- IN OPTIONAL HCERTSTORE hSiblingStore,
- IN DWORD dwUpdateFlags,
- IN DWORD dwPriority
- );
- WINCRYPT32API
- void
- WINAPI
- CertRemoveStoreFromCollection(
- IN HCERTSTORE hCollectionStore,
- IN HCERTSTORE hSiblingStore
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CertControlStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwFlags,
- IN DWORD dwCtrlType,
- IN void const *pvCtrlPara
- );
- //+-------------------------------------------------------------------------
- // Certificate Store control types
- //--------------------------------------------------------------------------
- #define CERT_STORE_CTRL_RESYNC 1
- #define CERT_STORE_CTRL_NOTIFY_CHANGE 2
- #define CERT_STORE_CTRL_COMMIT 3
- #define CERT_STORE_CTRL_AUTO_RESYNC 4
- #define CERT_STORE_CTRL_CANCEL_NOTIFY 5
- #define CERT_STORE_CTRL_INHIBIT_DUPLICATE_HANDLE_FLAG 0x1
- //+-------------------------------------------------------------------------
- // CERT_STORE_CTRL_RESYNC
- //
- // Re-synchronize the store.
- //
- // The pvCtrlPara points to the event HANDLE to be signaled on
- // the next store change. Normally, this would be the same
- // event HANDLE passed to CERT_STORE_CTRL_NOTIFY_CHANGE during initialization.
- //
- // If pvCtrlPara is NULL, no events are re-armed.
- //
- // By default the event HANDLE is DuplicateHandle'd.
- // CERT_STORE_CTRL_INHIBIT_DUPLICATE_HANDLE_FLAG can be set in dwFlags
- // to inhibit a DupicateHandle of the event HANDLE. If this flag
- // is set, then, CertControlStore(CERT_STORE_CTRL_CANCEL_NOTIFY) must be
- // called for this event HANDLE before closing the hCertStore.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_STORE_CTRL_NOTIFY_CHANGE
- //
- // Signal the event when the underlying store is changed.
- //
- // pvCtrlPara points to the event HANDLE to be signaled.
- //
- // pvCtrlPara can be NULL to inform the store of a subsequent
- // CERT_STORE_CTRL_RESYNC and allow it to optimize by only doing a resync
- // if the store has changed. For the registry based stores, an internal
- // notify change event is created and registered to be signaled.
- //
- // Recommend calling CERT_STORE_CTRL_NOTIFY_CHANGE once for each event to
- // be passed to CERT_STORE_CTRL_RESYNC. This should only happen after
- // the event has been created. Not after each time the event is signaled.
- //
- // By default the event HANDLE is DuplicateHandle'd.
- // CERT_STORE_CTRL_INHIBIT_DUPLICATE_HANDLE_FLAG can be set in dwFlags
- // to inhibit a DupicateHandle of the event HANDLE. If this flag
- // is set, then, CertControlStore(CERT_STORE_CTRL_CANCEL_NOTIFY) must be
- // called for this event HANDLE before closing the hCertStore.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_STORE_CTRL_CANCEL_NOTIFY
- //
- // Cancel notification signaling of the event HANDLE passed in a previous
- // CERT_STORE_CTRL_NOTIFY_CHANGE or CERT_STORE_CTRL_RESYNC.
- //
- // pvCtrlPara points to the event HANDLE to be canceled.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_STORE_CTRL_AUTO_RESYNC
- //
- // At the start of every enumeration or find store API call, check if the
- // underlying store has changed. If it has changed, re-synchronize.
- //
- // This check is only done in the enumeration or find APIs when the
- // pPrevContext is NULL.
- //
- // The pvCtrlPara isn't used and must be set to NULL.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_STORE_CTRL_COMMIT
- //
- // If any changes have been to the cached store, they are committed to
- // persisted storage. If no changes have been made since the store was
- // opened or the last commit, this call is ignored. May also be ignored by
- // store providers that persist changes immediately.
- //
- // CERT_STORE_CTRL_COMMIT_FORCE_FLAG can be set to force the store
- // to be committed even if it hasn't been touched.
- //
- // CERT_STORE_CTRL_COMMIT_CLEAR_FLAG can be set to inhibit a commit on
- // store close.
- //--------------------------------------------------------------------------
- #define CERT_STORE_CTRL_COMMIT_FORCE_FLAG 0x1
- #define CERT_STORE_CTRL_COMMIT_CLEAR_FLAG 0x2
- //+=========================================================================
- // Cert Store Property Defines and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Store property IDs. This is a property applicable to the entire store.
- // Its not a property on an individual certificate, CRL or CTL context.
- //
- // Currently, no store properties are persisted. (This differs from
- // most context properties which are persisted.)
- //
- // See CertSetStoreProperty or CertGetStoreProperty for usage information.
- //
- // Note, the range for predefined store properties should be outside
- // the range of predefined context properties. We will start at 4096.
- //--------------------------------------------------------------------------
- #define CERT_STORE_LOCALIZED_NAME_PROP_ID 0x1000
- //+-------------------------------------------------------------------------
- // Set a store property.
- //
- // The type definition for pvData depends on the dwPropId value.
- // CERT_STORE_LOCALIZED_NAME_PROP_ID - localized name of the store.
- // pvData points to a CRYPT_DATA_BLOB. pbData is a pointer to a NULL
- // terminated unicode, wide character string.
- // cbData = (wcslen((LPWSTR) pbData) + 1) * sizeof(WCHAR).
- //
- // For all the other PROP_IDs: an encoded PCRYPT_DATA_BLOB is passed in pvData.
- //
- // If the property already exists, then, the old value is deleted and silently
- // replaced. Setting, pvData to NULL, deletes the property.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSetStoreProperty(
- IN HCERTSTORE hCertStore,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN const void *pvData
- );
- //+-------------------------------------------------------------------------
- // Get a store property.
- //
- // The type definition for pvData depends on the dwPropId value.
- // CERT_STORE_LOCALIZED_NAME_PROP_ID - localized name of the store.
- // pvData points to a NULL terminated unicode, wide character string.
- // cbData = (wcslen((LPWSTR) pvData) + 1) * sizeof(WCHAR).
- //
- // For all other PROP_IDs, pvData points to an array of bytes.
- //
- // If the property doesn't exist, returns FALSE and sets LastError to
- // CRYPT_E_NOT_FOUND.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetStoreProperty(
- IN HCERTSTORE hCertStore,
- IN DWORD dwPropId,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- typedef struct _CERT_CREATE_CONTEXT_PARA {
- DWORD cbSize;
- PFN_CRYPT_FREE pfnFree; // OPTIONAL
- void *pvFree; // OPTIONAL
- } CERT_CREATE_CONTEXT_PARA, *PCERT_CREATE_CONTEXT_PARA;
- //+-------------------------------------------------------------------------
- // Creates the specified context from the encoded bytes. The created
- // context isn't put in a store.
- //
- // dwContextType values:
- // CERT_STORE_CERTIFICATE_CONTEXT
- // CERT_STORE_CRL_CONTEXT
- // CERT_STORE_CTL_CONTEXT
- //
- // If CERT_CREATE_CONTEXT_NOCOPY_FLAG is set, the created context points
- // directly to the pbEncoded instead of an allocated copy. See flag
- // definition for more details.
- //
- // If CERT_CREATE_CONTEXT_SORTED_FLAG is set, the context is created
- // with sorted entries. This flag may only be set for CERT_STORE_CTL_CONTEXT.
- // Setting this flag implicitly sets CERT_CREATE_CONTEXT_NO_HCRYPTMSG_FLAG and
- // CERT_CREATE_CONTEXT_NO_ENTRY_FLAG. See flag definition for
- // more details.
- //
- // If CERT_CREATE_CONTEXT_NO_HCRYPTMSG_FLAG is set, the context is created
- // without creating a HCRYPTMSG handle for the context. This flag may only be
- // set for CERT_STORE_CTL_CONTEXT. See flag definition for more details.
- //
- // If CERT_CREATE_CONTEXT_NO_ENTRY_FLAG is set, the context is created
- // without decoding the entries. This flag may only be set for
- // CERT_STORE_CTL_CONTEXT. See flag definition for more details.
- //
- // If unable to decode and create the context, NULL is returned.
- // Otherwise, a pointer to a read only CERT_CONTEXT, CRL_CONTEXT or
- // CTL_CONTEXT is returned. The context must be freed by the appropriate
- // free context API. The context can be duplicated by calling the
- // appropriate duplicate context API.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- const void *
- WINAPI
- CertCreateContext(
- IN DWORD dwContextType,
- IN DWORD dwEncodingType,
- IN const BYTE *pbEncoded,
- IN DWORD cbEncoded,
- IN DWORD dwFlags,
- IN OPTIONAL PCERT_CREATE_CONTEXT_PARA pCreatePara
- );
- // When the following flag is set, the created context points directly to the
- // pbEncoded instead of an allocated copy. If pCreatePara and
- // pCreatePara->pfnFree are non-NULL, then, pfnFree is called to free
- // the pbEncoded when the context is last freed. Otherwise, no attempt is
- // made to free the pbEncoded. If pCreatePara->pvFree is non-NULL, then its
- // passed to pfnFree instead of pbEncoded.
- //
- // Note, if CertCreateContext fails, pfnFree is still called.
- #define CERT_CREATE_CONTEXT_NOCOPY_FLAG 0x1
- // When the following flag is set, a context with sorted entries is created.
- // Currently only applicable to a CTL context.
- //
- // For CTLs: the cCTLEntry in the returned CTL_INFO is always
- // 0. CertFindSubjectInSortedCTL and CertEnumSubjectInSortedCTL must be called
- // to find or enumerate the CTL entries.
- //
- // The Sorted CTL TrustedSubjects extension isn't returned in the created
- // context's CTL_INFO.
- #define CERT_CREATE_CONTEXT_SORTED_FLAG 0x2
- // By default when a CTL context is created, a HCRYPTMSG handle to its
- // SignedData message is created. This flag can be set to improve performance
- // by not creating the HCRYPTMSG handle.
- //
- // This flag is only applicable to a CTL context.
- #define CERT_CREATE_CONTEXT_NO_HCRYPTMSG_FLAG 0x4
- // By default when a CTL context is created, its entries are decoded.
- // This flag can be set to improve performance by not decoding the
- // entries.
- //
- // This flag is only applicable to a CTL context.
- #define CERT_CREATE_CONTEXT_NO_ENTRY_FLAG 0x8
- //+=========================================================================
- // Certificate System Store Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // System Store Information
- //
- // Currently, no system store information is persisted.
- //--------------------------------------------------------------------------
- typedef struct _CERT_SYSTEM_STORE_INFO {
- DWORD cbSize;
- } CERT_SYSTEM_STORE_INFO, *PCERT_SYSTEM_STORE_INFO;
- //+-------------------------------------------------------------------------
- // Physical Store Information
- //
- // The Open fields are passed directly to CertOpenStore() to open
- // the physical store.
- //
- // By default all system stores located in the registry have an
- // implicit SystemRegistry physical store that is opened. To disable the
- // opening of this store, the SystemRegistry
- // physical store corresponding to the System store must be registered with
- // CERT_PHYSICAL_STORE_OPEN_DISABLE_FLAG set in dwFlags. Alternatively,
- // a physical store with the name of ".Default" may be registered.
- //
- // Depending on the store location and store name, additional predefined
- // physical stores may be opened. For example, system stores in
- // CURRENT_USER have the predefined physical store, .LocalMachine.
- // To disable the opening of these predefined physical stores, the
- // corresponding physical store must be registered with
- // CERT_PHYSICAL_STORE_OPEN_DISABLE_FLAG set in dwFlags.
- //
- // The CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG must be set in dwFlags
- // to enable the adding of a context to the store.
- //
- // When a system store is opened via the SERVICES or USERS store location,
- // the ServiceName\ is prepended to the OpenParameters
- // for CERT_SYSTEM_STORE_CURRENT_USER or CERT_SYSTEM_STORE_CURRENT_SERVICE
- // physical stores and the dwOpenFlags store location is changed to
- // CERT_SYSTEM_STORE_USERS or CERT_SYSTEM_STORE_SERVICES.
- //
- // By default the SYSTEM, SYSTEM_REGISTRY and PHYSICAL provider
- // stores are also opened remotely when the outer system store is opened.
- // The CERT_PHYSICAL_STORE_REMOTE_OPEN_DISABLE_FLAG may be set in dwFlags
- // to disable remote opens.
- //
- // When opened remotely, the \\ComputerName is implicitly prepended to the
- // OpenParameters for the SYSTEM, SYSTEM_REGISTRY and PHYSICAL provider types.
- // To also prepend the \\ComputerName to other provider types, set the
- // CERT_PHYSICAL_STORE_INSERT_COMPUTER_NAME_ENABLE_FLAG in dwFlags.
- //
- // When the system store is opened, its physical stores are ordered
- // according to the dwPriority. A larger dwPriority indicates higher priority.
- //--------------------------------------------------------------------------
- typedef struct _CERT_PHYSICAL_STORE_INFO {
- DWORD cbSize;
- LPSTR pszOpenStoreProvider; // REG_SZ
- DWORD dwOpenEncodingType; // REG_DWORD
- DWORD dwOpenFlags; // REG_DWORD
- CRYPT_DATA_BLOB OpenParameters; // REG_BINARY
- DWORD dwFlags; // REG_DWORD
- DWORD dwPriority; // REG_DWORD
- } CERT_PHYSICAL_STORE_INFO, *PCERT_PHYSICAL_STORE_INFO;
- //+-------------------------------------------------------------------------
- // Physical Store Information dwFlags
- //--------------------------------------------------------------------------
- #define CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG 0x1
- #define CERT_PHYSICAL_STORE_OPEN_DISABLE_FLAG 0x2
- #define CERT_PHYSICAL_STORE_REMOTE_OPEN_DISABLE_FLAG 0x4
- #define CERT_PHYSICAL_STORE_INSERT_COMPUTER_NAME_ENABLE_FLAG 0x8
- //+-------------------------------------------------------------------------
- // Register a system store.
- //
- // The upper word of the dwFlags parameter is used to specify the location of
- // the system store.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvSystemStore
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure. Otherwise,
- // pvSystemStore points to a null terminated UNICODE string.
- //
- // The CERT_SYSTEM_STORE_SERVICES or CERT_SYSTEM_STORE_USERS system store
- // name must be prefixed with the ServiceName or UserName. For example,
- // "ServiceName\Trust".
- //
- // Stores on remote computers can be registered for the
- // CERT_SYSTEM_STORE_LOCAL_MACHINE, CERT_SYSTEM_STORE_SERVICES,
- // CERT_SYSTEM_STORE_USERS, CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY
- // or CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE
- // locations by prepending the computer name. For example, a remote
- // local machine store is registered via "\\ComputerName\Trust" or
- // "ComputerName\Trust". A remote service store is registered via
- // "\\ComputerName\ServiceName\Trust". The leading "\\" backslashes are
- // optional in the ComputerName.
- //
- // Set CERT_STORE_CREATE_NEW_FLAG to cause a failure if the system store
- // already exists in the store location.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertRegisterSystemStore(
- IN const void *pvSystemStore,
- IN DWORD dwFlags,
- IN PCERT_SYSTEM_STORE_INFO pStoreInfo,
- IN OPTIONAL void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // Register a physical store for the specified system store.
- //
- // The upper word of the dwFlags parameter is used to specify the location of
- // the system store.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvSystemStore
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure. Otherwise,
- // pvSystemStore points to a null terminated UNICODE string.
- //
- // See CertRegisterSystemStore for details on prepending a ServiceName
- // and/or ComputerName to the system store name.
- //
- // Set CERT_STORE_CREATE_NEW_FLAG to cause a failure if the physical store
- // already exists in the system store.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertRegisterPhysicalStore(
- IN const void *pvSystemStore,
- IN DWORD dwFlags,
- IN LPCWSTR pwszStoreName,
- IN PCERT_PHYSICAL_STORE_INFO pStoreInfo,
- IN OPTIONAL void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // Unregister the specified system store.
- //
- // The upper word of the dwFlags parameter is used to specify the location of
- // the system store.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvSystemStore
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure. Otherwise,
- // pvSystemStore points to a null terminated UNICODE string.
- //
- // See CertRegisterSystemStore for details on prepending a ServiceName
- // and/or ComputerName to the system store name.
- //
- // CERT_STORE_DELETE_FLAG can optionally be set in dwFlags.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertUnregisterSystemStore(
- IN const void *pvSystemStore,
- IN DWORD dwFlags
- );
- //+-------------------------------------------------------------------------
- // Unregister the physical store from the specified system store.
- //
- // The upper word of the dwFlags parameter is used to specify the location of
- // the system store.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvSystemStore
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure. Otherwise,
- // pvSystemStore points to a null terminated UNICODE string.
- //
- // See CertRegisterSystemStore for details on prepending a ServiceName
- // and/or ComputerName to the system store name.
- //
- // CERT_STORE_DELETE_FLAG can optionally be set in dwFlags.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertUnregisterPhysicalStore(
- IN const void *pvSystemStore,
- IN DWORD dwFlags,
- IN LPCWSTR pwszStoreName
- );
- //+-------------------------------------------------------------------------
- // Enum callbacks
- //
- // The CERT_SYSTEM_STORE_LOCATION_MASK bits in the dwFlags parameter
- // specifies the location of the system store
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvSystemStore
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure. Otherwise,
- // pvSystemStore points to a null terminated UNICODE string.
- //
- // The callback returns FALSE and sets LAST_ERROR to stop the enumeration.
- // The LAST_ERROR is returned to the caller of the enumeration.
- //
- // The pvSystemStore passed to the callback has leading ComputerName and/or
- // ServiceName prefixes where appropriate.
- //--------------------------------------------------------------------------
- typedef BOOL (WINAPI *PFN_CERT_ENUM_SYSTEM_STORE_LOCATION)(
- IN LPCWSTR pwszStoreLocation,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved,
- IN OPTIONAL void *pvArg
- );
- typedef BOOL (WINAPI *PFN_CERT_ENUM_SYSTEM_STORE)(
- IN const void *pvSystemStore,
- IN DWORD dwFlags,
- IN PCERT_SYSTEM_STORE_INFO pStoreInfo,
- IN OPTIONAL void *pvReserved,
- IN OPTIONAL void *pvArg
- );
- typedef BOOL (WINAPI *PFN_CERT_ENUM_PHYSICAL_STORE)(
- IN const void *pvSystemStore,
- IN DWORD dwFlags,
- IN LPCWSTR pwszStoreName,
- IN PCERT_PHYSICAL_STORE_INFO pStoreInfo,
- IN OPTIONAL void *pvReserved,
- IN OPTIONAL void *pvArg
- );
- // In the PFN_CERT_ENUM_PHYSICAL_STORE callback the following flag is
- // set if the physical store wasn't registered and is an implicitly created
- // predefined physical store.
- #define CERT_PHYSICAL_STORE_PREDEFINED_ENUM_FLAG 0x1
- // Names of implicitly created predefined physical stores
- #define CERT_PHYSICAL_STORE_DEFAULT_NAME L".Default"
- #define CERT_PHYSICAL_STORE_GROUP_POLICY_NAME L".GroupPolicy"
- #define CERT_PHYSICAL_STORE_LOCAL_MACHINE_NAME L".LocalMachine"
- #define CERT_PHYSICAL_STORE_DS_USER_CERTIFICATE_NAME L".UserCertificate"
- #define CERT_PHYSICAL_STORE_LOCAL_MACHINE_GROUP_POLICY_NAME \
- L".LocalMachineGroupPolicy"
- #define CERT_PHYSICAL_STORE_ENTERPRISE_NAME L".Enterprise"
- #define CERT_PHYSICAL_STORE_AUTH_ROOT_NAME L".AuthRoot"
- //+-------------------------------------------------------------------------
- // Enumerate the system store locations.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertEnumSystemStoreLocation(
- IN DWORD dwFlags,
- IN void *pvArg,
- IN PFN_CERT_ENUM_SYSTEM_STORE_LOCATION pfnEnum
- );
- //+-------------------------------------------------------------------------
- // Enumerate the system stores.
- //
- // The upper word of the dwFlags parameter is used to specify the location of
- // the system store.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags,
- // pvSystemStoreLocationPara points to a CERT_SYSTEM_STORE_RELOCATE_PARA
- // data structure. Otherwise, pvSystemStoreLocationPara points to a null
- // terminated UNICODE string.
- //
- // For CERT_SYSTEM_STORE_LOCAL_MACHINE,
- // CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY or
- // CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE, pvSystemStoreLocationPara can
- // optionally be set to a unicode computer name for enumerating local machine
- // stores on a remote computer. For example, "\\ComputerName" or
- // "ComputerName". The leading "\\" backslashes are optional in the
- // ComputerName.
- //
- // For CERT_SYSTEM_STORE_SERVICES or CERT_SYSTEM_STORE_USERS,
- // if pvSystemStoreLocationPara is NULL, then,
- // enumerates both the service/user names and the stores for each service/user
- // name. Otherwise, pvSystemStoreLocationPara is a unicode string specifying a
- // remote computer name and/or service/user name. For example:
- // "ServiceName"
- // "\\ComputerName" or "ComputerName\"
- // "ComputerName\ServiceName"
- // Note, if only the ComputerName is specified, then, it must have either
- // the leading "\\" backslashes or a trailing backslash. Otherwise, its
- // interpretted as the ServiceName or UserName.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertEnumSystemStore(
- IN DWORD dwFlags,
- IN OPTIONAL void *pvSystemStoreLocationPara,
- IN void *pvArg,
- IN PFN_CERT_ENUM_SYSTEM_STORE pfnEnum
- );
- //+-------------------------------------------------------------------------
- // Enumerate the physical stores for the specified system store.
- //
- // The upper word of the dwFlags parameter is used to specify the location of
- // the system store.
- //
- // If CERT_SYSTEM_STORE_RELOCATE_FLAG is set in dwFlags, pvSystemStore
- // points to a CERT_SYSTEM_STORE_RELOCATE_PARA data structure. Otherwise,
- // pvSystemStore points to a null terminated UNICODE string.
- //
- // See CertRegisterSystemStore for details on prepending a ServiceName
- // and/or ComputerName to the system store name.
- //
- // If the system store location only supports system stores and doesn't
- // support physical stores, LastError is set to ERROR_CALL_NOT_IMPLEMENTED.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertEnumPhysicalStore(
- IN const void *pvSystemStore,
- IN DWORD dwFlags,
- IN void *pvArg,
- IN PFN_CERT_ENUM_PHYSICAL_STORE pfnEnum
- );
- //+-------------------------------------------------------------------------
- // Certificate System Store Installable Functions
- //
- // The CERT_SYSTEM_STORE_LOCATION_MASK bits in the dwFlags parameter passed
- // to the CertOpenStore(for "System", "SystemRegistry" or "Physical"
- // Provider), CertRegisterSystemStore,
- // CertUnregisterSystemStore, CertEnumSystemStore, CertRegisterPhysicalStore,
- // CertUnregisterPhysicalStore and CertEnumPhysicalStore APIs is used as the
- // constant pszOID value passed to the OID installable functions.
- // Therefore, the pszOID is restricted to a constant <= (LPCSTR) 0x0FFF.
- //
- // The EncodingType is 0.
- //--------------------------------------------------------------------------
- // Installable System Store Provider OID pszFuncNames.
- #define CRYPT_OID_OPEN_SYSTEM_STORE_PROV_FUNC "CertDllOpenSystemStoreProv"
- #define CRYPT_OID_REGISTER_SYSTEM_STORE_FUNC "CertDllRegisterSystemStore"
- #define CRYPT_OID_UNREGISTER_SYSTEM_STORE_FUNC "CertDllUnregisterSystemStore"
- #define CRYPT_OID_ENUM_SYSTEM_STORE_FUNC "CertDllEnumSystemStore"
- #define CRYPT_OID_REGISTER_PHYSICAL_STORE_FUNC "CertDllRegisterPhysicalStore"
- #define CRYPT_OID_UNREGISTER_PHYSICAL_STORE_FUNC "CertDllUnregisterPhysicalStore"
- #define CRYPT_OID_ENUM_PHYSICAL_STORE_FUNC "CertDllEnumPhysicalStore"
- // CertDllOpenSystemStoreProv has the same function signature as the
- // installable "CertDllOpenStoreProv" function. See CertOpenStore for
- // more details.
- // CertDllRegisterSystemStore has the same function signature as
- // CertRegisterSystemStore.
- //
- // The "SystemStoreLocation" REG_SZ value must also be set for registered
- // CertDllEnumSystemStore OID functions.
- #define CRYPT_OID_SYSTEM_STORE_LOCATION_VALUE_NAME L"SystemStoreLocation"
- // The remaining Register, Enum and Unregister OID installable functions
- // have the same signature as their Cert Store API counterpart.
- //+=========================================================================
- // Enhanced Key Usage Helper Functions
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Get the enhanced key usage extension or property from the certificate
- // and decode.
- //
- // If the CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG is set, then, only get the
- // extension.
- //
- // If the CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG is set, then, only get the
- // property.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetEnhancedKeyUsage(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwFlags,
- OUT PCERT_ENHKEY_USAGE pUsage,
- IN OUT DWORD *pcbUsage
- );
- //+-------------------------------------------------------------------------
- // Set the enhanced key usage property for the certificate.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertSetEnhancedKeyUsage(
- IN PCCERT_CONTEXT pCertContext,
- IN PCERT_ENHKEY_USAGE pUsage
- );
- //+-------------------------------------------------------------------------
- // Add the usage identifier to the certificate's enhanced key usage property.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddEnhancedKeyUsageIdentifier(
- IN PCCERT_CONTEXT pCertContext,
- IN LPCSTR pszUsageIdentifier
- );
- //+-------------------------------------------------------------------------
- // Remove the usage identifier from the certificate's enhanced key usage
- // property.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertRemoveEnhancedKeyUsageIdentifier(
- IN PCCERT_CONTEXT pCertContext,
- IN LPCSTR pszUsageIdentifier
- );
- //+---------------------------------------------------------------------------
- //
- //
- // Takes an array of certs and returns an array of usages
- // which consists of the intersection of the valid usages for each cert.
- // If each cert is good for all possible usages then the cNumOIDs is set to -1.
- //
- //----------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetValidUsages(
- IN DWORD cCerts,
- IN PCCERT_CONTEXT *rghCerts,
- OUT int *cNumOIDs,
- OUT LPSTR *rghOIDs,
- IN OUT DWORD *pcbOIDs);
- //+=========================================================================
- // Cryptographic Message helper functions for verifying and signing a
- // CTL.
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Get and verify the signer of a cryptographic message.
- //
- // To verify a CTL, the hCryptMsg is obtained from the CTL_CONTEXT's
- // hCryptMsg field.
- //
- // If CMSG_TRUSTED_SIGNER_FLAG is set, then, treat the Signer stores as being
- // trusted and only search them to find the certificate corresponding to the
- // signer's issuer and serial number. Otherwise, the SignerStores are
- // optionally provided to supplement the message's store of certificates.
- // If a signer certificate is found, its public key is used to verify
- // the message signature. The CMSG_SIGNER_ONLY_FLAG can be set to
- // return the signer without doing the signature verify.
- //
- // If CMSG_USE_SIGNER_INDEX_FLAG is set, then, only get the signer specified
- // by *pdwSignerIndex. Otherwise, iterate through all the signers
- // until a signer verifies or no more signers.
- //
- // For a verified signature, *ppSigner is updated with certificate context
- // of the signer and *pdwSignerIndex is updated with the index of the signer.
- // ppSigner and/or pdwSignerIndex can be NULL, indicating the caller isn't
- // interested in getting the CertContext and/or index of the signer.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptMsgGetAndVerifySigner(
- IN HCRYPTMSG hCryptMsg,
- IN DWORD cSignerStore,
- IN OPTIONAL HCERTSTORE *rghSignerStore,
- IN DWORD dwFlags,
- OUT OPTIONAL PCCERT_CONTEXT *ppSigner,
- IN OUT OPTIONAL DWORD *pdwSignerIndex
- );
- #define CMSG_TRUSTED_SIGNER_FLAG 0x1
- #define CMSG_SIGNER_ONLY_FLAG 0x2
- #define CMSG_USE_SIGNER_INDEX_FLAG 0x4
- //+-------------------------------------------------------------------------
- // Sign an encoded CTL.
- //
- // The pbCtlContent can be obtained via a CTL_CONTEXT's pbCtlContent
- // field or via a CryptEncodeObject(PKCS_CTL or PKCS_SORTED_CTL).
- //
- // CMSG_CMS_ENCAPSULATED_CTL_FLAG can be set to encode a CMS compatible
- // V3 SignedData message.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptMsgSignCTL(
- IN DWORD dwMsgEncodingType,
- IN BYTE *pbCtlContent,
- IN DWORD cbCtlContent,
- IN PCMSG_SIGNED_ENCODE_INFO pSignInfo,
- IN DWORD dwFlags,
- OUT BYTE *pbEncoded,
- IN OUT DWORD *pcbEncoded
- );
- // When set, CTL inner content is encapsulated within an OCTET STRING
- #define CMSG_CMS_ENCAPSULATED_CTL_FLAG 0x00008000
- //+-------------------------------------------------------------------------
- // Encode the CTL and create a signed message containing the encoded CTL.
- //
- // Set CMSG_ENCODE_SORTED_CTL_FLAG if the CTL entries are to be sorted
- // before encoding. This flag should be set, if the
- // CertFindSubjectInSortedCTL or CertEnumSubjectInSortedCTL APIs will
- // be called. If the identifier for the CTL entries is a hash, such as,
- // MD5 or SHA1, then, CMSG_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG should
- // also be set.
- //
- // CMSG_CMS_ENCAPSULATED_CTL_FLAG can be set to encode a CMS compatible
- // V3 SignedData message.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptMsgEncodeAndSignCTL(
- IN DWORD dwMsgEncodingType,
- IN PCTL_INFO pCtlInfo,
- IN PCMSG_SIGNED_ENCODE_INFO pSignInfo,
- IN DWORD dwFlags,
- OUT BYTE *pbEncoded,
- IN OUT DWORD *pcbEncoded
- );
- // The following flag is set if the CTL is to be encoded with sorted
- // trusted subjects and the szOID_SORTED_CTL extension is inserted containing
- // sorted offsets to the encoded subjects.
- #define CMSG_ENCODE_SORTED_CTL_FLAG 0x1
- // If the above sorted flag is set, then, the following flag should also
- // be set if the identifier for the TrustedSubjects is a hash,
- // such as, MD5 or SHA1.
- #define CMSG_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG 0x2
- //+-------------------------------------------------------------------------
- // Returns TRUE if the SubjectIdentifier exists in the CTL. Optionally
- // returns a pointer to and byte count of the Subject's encoded attributes.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertFindSubjectInSortedCTL(
- IN PCRYPT_DATA_BLOB pSubjectIdentifier,
- IN PCCTL_CONTEXT pCtlContext,
- IN DWORD dwFlags,
- IN void *pvReserved,
- OUT OPTIONAL PCRYPT_DER_BLOB pEncodedAttributes
- );
- //+-------------------------------------------------------------------------
- // Enumerates through the sequence of TrustedSubjects in a CTL context
- // created with CERT_CREATE_CONTEXT_SORTED_FLAG set.
- //
- // To start the enumeration, *ppvNextSubject must be NULL. Upon return,
- // *ppvNextSubject is updated to point to the next TrustedSubject in
- // the encoded sequence.
- //
- // Returns FALSE for no more subjects or invalid arguments.
- //
- // Note, the returned DER_BLOBs point directly into the encoded
- // bytes (not allocated, and must not be freed).
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertEnumSubjectInSortedCTL(
- IN PCCTL_CONTEXT pCtlContext,
- IN OUT void **ppvNextSubject,
- OUT OPTIONAL PCRYPT_DER_BLOB pSubjectIdentifier,
- OUT OPTIONAL PCRYPT_DER_BLOB pEncodedAttributes
- );
- //+=========================================================================
- // Certificate Verify CTL Usage Data Structures and APIs
- //==========================================================================
- typedef struct _CTL_VERIFY_USAGE_PARA {
- DWORD cbSize;
- CRYPT_DATA_BLOB ListIdentifier; // OPTIONAL
- DWORD cCtlStore;
- HCERTSTORE *rghCtlStore; // OPTIONAL
- DWORD cSignerStore;
- HCERTSTORE *rghSignerStore; // OPTIONAL
- } CTL_VERIFY_USAGE_PARA, *PCTL_VERIFY_USAGE_PARA;
- typedef struct _CTL_VERIFY_USAGE_STATUS {
- DWORD cbSize;
- DWORD dwError;
- DWORD dwFlags;
- PCCTL_CONTEXT *ppCtl; // IN OUT OPTIONAL
- DWORD dwCtlEntryIndex;
- PCCERT_CONTEXT *ppSigner; // IN OUT OPTIONAL
- DWORD dwSignerIndex;
- } CTL_VERIFY_USAGE_STATUS, *PCTL_VERIFY_USAGE_STATUS;
- #define CERT_VERIFY_INHIBIT_CTL_UPDATE_FLAG 0x1
- #define CERT_VERIFY_TRUSTED_SIGNERS_FLAG 0x2
- #define CERT_VERIFY_NO_TIME_CHECK_FLAG 0x4
- #define CERT_VERIFY_ALLOW_MORE_USAGE_FLAG 0x8
- #define CERT_VERIFY_UPDATED_CTL_FLAG 0x1
- //+-------------------------------------------------------------------------
- // Verify that a subject is trusted for the specified usage by finding a
- // signed and time valid CTL with the usage identifiers and containing the
- // the subject. A subject can be identified by either its certificate context
- // or any identifier such as its SHA1 hash.
- //
- // See CertFindSubjectInCTL for definition of dwSubjectType and pvSubject
- // parameters.
- //
- // Via pVerifyUsagePara, the caller can specify the stores to be searched
- // to find the CTL. The caller can also specify the stores containing
- // acceptable CTL signers. By setting the ListIdentifier, the caller
- // can also restrict to a particular signer CTL list.
- //
- // Via pVerifyUsageStatus, the CTL containing the subject, the subject's
- // index into the CTL's array of entries, and the signer of the CTL
- // are returned. If the caller is not interested, ppCtl and ppSigner can be set
- // to NULL. Returned contexts must be freed via the store's free context APIs.
- //
- // If the CERT_VERIFY_INHIBIT_CTL_UPDATE_FLAG isn't set, then, a time
- // invalid CTL in one of the CtlStores may be replaced. When replaced, the
- // CERT_VERIFY_UPDATED_CTL_FLAG is set in pVerifyUsageStatus->dwFlags.
- //
- // If the CERT_VERIFY_TRUSTED_SIGNERS_FLAG is set, then, only the
- // SignerStores specified in pVerifyUsageStatus are searched to find
- // the signer. Otherwise, the SignerStores provide additional sources
- // to find the signer's certificate.
- //
- // If CERT_VERIFY_NO_TIME_CHECK_FLAG is set, then, the CTLs aren't checked
- // for time validity.
- //
- // If CERT_VERIFY_ALLOW_MORE_USAGE_FLAG is set, then, the CTL may contain
- // additional usage identifiers than specified by pSubjectUsage. Otherwise,
- // the found CTL will contain the same usage identifers and no more.
- //
- // CertVerifyCTLUsage will be implemented as a dispatcher to OID installable
- // functions. First, it will try to find an OID function matching the first
- // usage object identifier in the pUsage sequence. Next, it will dispatch
- // to the default CertDllVerifyCTLUsage functions.
- //
- // If the subject is trusted for the specified usage, then, TRUE is
- // returned. Otherwise, FALSE is returned with dwError set to one of the
- // following:
- // CRYPT_E_NO_VERIFY_USAGE_DLL
- // CRYPT_E_NO_VERIFY_USAGE_CHECK
- // CRYPT_E_VERIFY_USAGE_OFFLINE
- // CRYPT_E_NOT_IN_CTL
- // CRYPT_E_NO_TRUSTED_SIGNER
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertVerifyCTLUsage(
- IN DWORD dwEncodingType,
- IN DWORD dwSubjectType,
- IN void *pvSubject,
- IN PCTL_USAGE pSubjectUsage,
- IN DWORD dwFlags,
- IN OPTIONAL PCTL_VERIFY_USAGE_PARA pVerifyUsagePara,
- IN OUT PCTL_VERIFY_USAGE_STATUS pVerifyUsageStatus
- );
- //+=========================================================================
- // Certificate Revocation Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // This data structure is updated by a CRL revocation type handler
- // with the base and possibly the delta CRL used.
- //--------------------------------------------------------------------------
- typedef struct _CERT_REVOCATION_CRL_INFO {
- DWORD cbSize;
- PCCRL_CONTEXT pBaseCrlContext;
- PCCRL_CONTEXT pDeltaCrlContext;
- // When revoked, points to entry in either of the above CRL contexts.
- // Don't free.
- PCRL_ENTRY pCrlEntry;
- BOOL fDeltaCrlEntry; // TRUE if in pDeltaCrlContext
- } CERT_REVOCATION_CRL_INFO, *PCERT_REVOCATION_CRL_INFO;
- //+-------------------------------------------------------------------------
- // The following data structure may be passed to CertVerifyRevocation to
- // assist in finding the issuer of the context to be verified.
- //
- // When pIssuerCert is specified, pIssuerCert is the issuer of
- // rgpvContext[cContext - 1].
- //
- // When cCertStore and rgCertStore are specified, these stores may contain
- // an issuer certificate.
- //
- // When hCrlStore is specified then a handler which uses CRLs can search this
- // store for them
- //
- // When pftTimeToUse is specified then the handler (if possible) must determine
- // revocation status relative to the time given otherwise the answer may be
- // independent of time or relative to current time
- //--------------------------------------------------------------------------
- typedef struct _CERT_REVOCATION_PARA {
- DWORD cbSize;
- PCCERT_CONTEXT pIssuerCert;
- DWORD cCertStore;
- HCERTSTORE *rgCertStore;
- HCERTSTORE hCrlStore;
- LPFILETIME pftTimeToUse;
- #ifdef CERT_REVOCATION_PARA_HAS_EXTRA_FIELDS
- // Note, if you #define CERT_REVOCATION_PARA_HAS_EXTRA_FIELDS, then, you
- // must zero all unused fields in this data structure.
- // More fields could be added in a future release.
- // 0 uses revocation handler's default timeout.
- DWORD dwUrlRetrievalTimeout; // milliseconds
- // When set, checks and attempts to retrieve a CRL where
- // ThisUpdate >= (CurrentTime - dwFreshnessTime). Otherwise, defaults
- // to using the CRL's NextUpdate.
- BOOL fCheckFreshnessTime;
- DWORD dwFreshnessTime; // seconds
- // If NULL, revocation handler gets the current time
- LPFILETIME pftCurrentTime;
- // If nonNULL, a CRL revocation type handler updates with the base and
- // possibly the delta CRL used. Note, *pCrlInfo must be initialized
- // by the caller. Any nonNULL CRL contexts are freed. Any updated
- // CRL contexts must be freed by the caller.
- //
- // The CRL info is only applicable to the last context checked. If
- // interested in this information, then, CertVerifyRevocation should be
- // called with cContext = 1.
- PCERT_REVOCATION_CRL_INFO pCrlInfo;
- #endif
- } CERT_REVOCATION_PARA, *PCERT_REVOCATION_PARA;
- //+-------------------------------------------------------------------------
- // The following data structure is returned by CertVerifyRevocation to
- // specify the status of the revoked or unchecked context. Review the
- // following CertVerifyRevocation comments for details.
- //
- // Upon input to CertVerifyRevocation, cbSize must be set to a size
- // >= (offsetof(CERT_REVOCATION_STATUS, dwReason) + sizeof(DWORD) ).
- // Otherwise, CertVerifyRevocation returns FALSE and sets LastError to
- // E_INVALIDARG.
- //
- // Upon input to the installed or registered CRYPT_OID_VERIFY_REVOCATION_FUNC
- // functions, the dwIndex, dwError and dwReason have been zero'ed.
- // If present, fHasFreshnessTime and dwFreshnessTime have been zero'ed.
- //--------------------------------------------------------------------------
- typedef struct _CERT_REVOCATION_STATUS {
- DWORD cbSize;
- DWORD dwIndex;
- DWORD dwError;
- DWORD dwReason;
- // Depending on cbSize, the following fields may optionally be returned.
- // The Freshness time is only applicable to the last context checked. If
- // interested in this information, then, CertVerifyRevocation should be
- // called with cContext = 1.
- //
- // fHasFreshnessTime is only set if we are able to retrieve revocation
- // information. For a CRL its CurrentTime - ThisUpdate.
- BOOL fHasFreshnessTime;
- DWORD dwFreshnessTime; // seconds
- } CERT_REVOCATION_STATUS, *PCERT_REVOCATION_STATUS;
- //+-------------------------------------------------------------------------
- // Verifies the array of contexts for revocation. The dwRevType parameter
- // indicates the type of the context data structure passed in rgpvContext.
- // Currently only the revocation of certificates is defined.
- //
- // If the CERT_VERIFY_REV_CHAIN_FLAG flag is set, then, CertVerifyRevocation
- // is verifying a chain of certs where, rgpvContext[i + 1] is the issuer
- // of rgpvContext[i]. Otherwise, CertVerifyRevocation makes no assumptions
- // about the order of the contexts.
- //
- // To assist in finding the issuer, the pRevPara may optionally be set. See
- // the CERT_REVOCATION_PARA data structure for details.
- //
- // The contexts must contain enough information to allow the
- // installable or registered revocation DLLs to find the revocation server. For
- // certificates, this information would normally be conveyed in an
- // extension such as the IETF's AuthorityInfoAccess extension.
- //
- // CertVerifyRevocation returns TRUE if all of the contexts were successfully
- // checked and none were revoked. Otherwise, returns FALSE and updates the
- // returned pRevStatus data structure as follows:
- // dwIndex
- // Index of the first context that was revoked or unable to
- // be checked for revocation
- // dwError
- // Error status. LastError is also set to this error status.
- // dwError can be set to one of the following error codes defined
- // in winerror.h:
- // ERROR_SUCCESS - good context
- // CRYPT_E_REVOKED - context was revoked. dwReason contains the
- // reason for revocation
- // CRYPT_E_REVOCATION_OFFLINE - unable to connect to the
- // revocation server
- // CRYPT_E_NOT_IN_REVOCATION_DATABASE - the context to be checked
- // was not found in the revocation server's database.
- // CRYPT_E_NO_REVOCATION_CHECK - the called revocation function
- // wasn't able to do a revocation check on the context
- // CRYPT_E_NO_REVOCATION_DLL - no installed or registered Dll was
- // found to verify revocation
- // dwReason
- // The dwReason is currently only set for CRYPT_E_REVOKED and contains
- // the reason why the context was revoked. May be one of the following
- // CRL reasons defined by the CRL Reason Code extension ("2.5.29.21")
- // CRL_REASON_UNSPECIFIED 0
- // CRL_REASON_KEY_COMPROMISE 1
- // CRL_REASON_CA_COMPROMISE 2
- // CRL_REASON_AFFILIATION_CHANGED 3
- // CRL_REASON_SUPERSEDED 4
- // CRL_REASON_CESSATION_OF_OPERATION 5
- // CRL_REASON_CERTIFICATE_HOLD 6
- //
- // For each entry in rgpvContext, CertVerifyRevocation iterates
- // through the CRYPT_OID_VERIFY_REVOCATION_FUNC
- // function set's list of installed DEFAULT functions.
- // CryptGetDefaultOIDFunctionAddress is called with pwszDll = NULL. If no
- // installed functions are found capable of doing the revocation verification,
- // CryptVerifyRevocation iterates through CRYPT_OID_VERIFY_REVOCATION_FUNC's
- // list of registered DEFAULT Dlls. CryptGetDefaultOIDDllList is called to
- // get the list. CryptGetDefaultOIDFunctionAddress is called to load the Dll.
- //
- // The called functions have the same signature as CertVerifyRevocation. A
- // called function returns TRUE if it was able to successfully check all of
- // the contexts and none were revoked. Otherwise, the called function returns
- // FALSE and updates pRevStatus. dwIndex is set to the index of
- // the first context that was found to be revoked or unable to be checked.
- // dwError and LastError are updated. For CRYPT_E_REVOKED, dwReason
- // is updated. Upon input to the called function, dwIndex, dwError and
- // dwReason have been zero'ed. cbSize has been checked to be >=
- // sizeof(CERT_REVOCATION_STATUS).
- //
- // If the called function returns FALSE, and dwError isn't set to
- // CRYPT_E_REVOKED, then, CertVerifyRevocation either continues on to the
- // next DLL in the list for a returned dwIndex of 0 or for a returned
- // dwIndex > 0, restarts the process of finding a verify function by
- // advancing the start of the context array to the returned dwIndex and
- // decrementing the count of remaining contexts.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertVerifyRevocation(
- IN DWORD dwEncodingType,
- IN DWORD dwRevType,
- IN DWORD cContext,
- IN PVOID rgpvContext[],
- IN DWORD dwFlags,
- IN OPTIONAL PCERT_REVOCATION_PARA pRevPara,
- IN OUT PCERT_REVOCATION_STATUS pRevStatus
- );
- //+-------------------------------------------------------------------------
- // Revocation types
- //--------------------------------------------------------------------------
- #define CERT_CONTEXT_REVOCATION_TYPE 1
- //+-------------------------------------------------------------------------
- // When the following flag is set, rgpvContext[] consists of a chain
- // of certificates, where rgpvContext[i + 1] is the issuer of rgpvContext[i].
- //--------------------------------------------------------------------------
- #define CERT_VERIFY_REV_CHAIN_FLAG 0x00000001
- //+-------------------------------------------------------------------------
- // CERT_VERIFY_CACHE_ONLY_BASED_REVOCATION prevents the revocation handler from
- // accessing any network based resources for revocation checking
- //--------------------------------------------------------------------------
- #define CERT_VERIFY_CACHE_ONLY_BASED_REVOCATION 0x00000002
- //+-------------------------------------------------------------------------
- // By default, the dwUrlRetrievalTimeout in pRevPara is the timeout used
- // for each URL wire retrieval. When the following flag is set,
- // dwUrlRetrievalTimeout is the accumulative timeout across all URL wire
- // retrievals.
- //--------------------------------------------------------------------------
- #define CERT_VERIFY_REV_ACCUMULATIVE_TIMEOUT_FLAG 0x00000004
- //+-------------------------------------------------------------------------
- // CERT_CONTEXT_REVOCATION_TYPE
- //
- // pvContext points to a const CERT_CONTEXT.
- //--------------------------------------------------------------------------
- //+=========================================================================
- // Certificate Helper APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Compare two multiple byte integer blobs to see if they are identical.
- //
- // Before doing the comparison, leading zero bytes are removed from a
- // positive number and leading 0xFF bytes are removed from a negative
- // number.
- //
- // The multiple byte integers are treated as Little Endian. pbData[0] is the
- // least significant byte and pbData[cbData - 1] is the most significant
- // byte.
- //
- // Returns TRUE if the integer blobs are identical after removing leading
- // 0 or 0xFF bytes.
- //--------------------------------------------------------------------------
- BOOL
- WINAPI
- CertCompareIntegerBlob(
- IN PCRYPT_INTEGER_BLOB pInt1,
- IN PCRYPT_INTEGER_BLOB pInt2
- );
- //+-------------------------------------------------------------------------
- // Compare two certificates to see if they are identical.
- //
- // Since a certificate is uniquely identified by its Issuer and SerialNumber,
- // these are the only fields needing to be compared.
- //
- // Returns TRUE if the certificates are identical.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertCompareCertificate(
- IN DWORD dwCertEncodingType,
- IN PCERT_INFO pCertId1,
- IN PCERT_INFO pCertId2
- );
- //+-------------------------------------------------------------------------
- // Compare two certificate names to see if they are identical.
- //
- // Returns TRUE if the names are identical.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertCompareCertificateName(
- IN DWORD dwCertEncodingType,
- IN PCERT_NAME_BLOB pCertName1,
- IN PCERT_NAME_BLOB pCertName2
- );
- //+-------------------------------------------------------------------------
- // Compare the attributes in the certificate name with the specified
- // Relative Distinguished Name's (CERT_RDN) array of attributes.
- // The comparison iterates through the CERT_RDN attributes and looks for an
- // attribute match in any of the certificate name's RDNs.
- // Returns TRUE if all the attributes are found and match.
- //
- // The CERT_RDN_ATTR fields can have the following special values:
- // pszObjId == NULL - ignore the attribute object identifier
- // dwValueType == RDN_ANY_TYPE - ignore the value type
- //
- // CERT_CASE_INSENSITIVE_IS_RDN_ATTRS_FLAG should be set to do
- // a case insensitive match. Otherwise, defaults to an exact, case sensitive
- // match.
- //
- // CERT_UNICODE_IS_RDN_ATTRS_FLAG should be set if the pRDN was initialized
- // with unicode strings as for CryptEncodeObject(X509_UNICODE_NAME).
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertIsRDNAttrsInCertificateName(
- IN DWORD dwCertEncodingType,
- IN DWORD dwFlags,
- IN PCERT_NAME_BLOB pCertName,
- IN PCERT_RDN pRDN
- );
- #define CERT_UNICODE_IS_RDN_ATTRS_FLAG 0x1
- #define CERT_CASE_INSENSITIVE_IS_RDN_ATTRS_FLAG 0x2
- //+-------------------------------------------------------------------------
- // Compare two public keys to see if they are identical.
- //
- // Returns TRUE if the keys are identical.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertComparePublicKeyInfo(
- IN DWORD dwCertEncodingType,
- IN PCERT_PUBLIC_KEY_INFO pPublicKey1,
- IN PCERT_PUBLIC_KEY_INFO pPublicKey2
- );
- //+-------------------------------------------------------------------------
- // Get the public/private key's bit length.
- //
- // Returns 0 if unable to determine the key's length.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertGetPublicKeyLength(
- IN DWORD dwCertEncodingType,
- IN PCERT_PUBLIC_KEY_INFO pPublicKey
- );
- //+-------------------------------------------------------------------------
- // Verify the signature of a subject certificate or a CRL using the
- // public key info
- //
- // Returns TRUE for a valid signature.
- //
- // hCryptProv specifies the crypto provider to use to verify the signature.
- // It doesn't need to use a private key.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptVerifyCertificateSignature(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwCertEncodingType,
- IN const BYTE * pbEncoded,
- IN DWORD cbEncoded,
- IN PCERT_PUBLIC_KEY_INFO pPublicKey
- );
- //+-------------------------------------------------------------------------
- // Verify the signature of a subject certificate, CRL, certificate request
- // or keygen request using the issuer's public key.
- //
- // Returns TRUE for a valid signature.
- //
- // The subject can be an encoded blob or a context for a certificate or CRL.
- // For a subject certificate context, if the certificate is missing
- // inheritable PublicKey Algorithm Parameters, the context's
- // CERT_PUBKEY_ALG_PARA_PROP_ID is updated with the issuer's public key
- // algorithm parameters for a valid signature.
- //
- // The issuer can be a pointer to a CERT_PUBLIC_KEY_INFO, certificate
- // context or a chain context.
- //
- // hCryptProv specifies the crypto provider to use to verify the signature.
- // Its private key isn't used. If hCryptProv is NULL, a default
- // provider is picked according to the PublicKey Algorithm OID.
- //
- // If the signature algorithm is a hashing algorithm, then, the
- // signature is expected to contain the hash octets. Only dwIssuerType
- // of CRYPT_VERIFY_CERT_SIGN_ISSUER_NULL may be specified
- // to verify this no signature case. If any other dwIssuerType is
- // specified, the verify will fail with LastError set to E_INVALIDARG.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptVerifyCertificateSignatureEx(
- IN OPTIONAL HCRYPTPROV hCryptProv,
- IN DWORD dwCertEncodingType,
- IN DWORD dwSubjectType,
- IN void *pvSubject,
- IN DWORD dwIssuerType,
- IN void *pvIssuer,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved
- );
- // Subject Types
- #define CRYPT_VERIFY_CERT_SIGN_SUBJECT_BLOB 1
- // pvSubject :: PCRYPT_DATA_BLOB
- #define CRYPT_VERIFY_CERT_SIGN_SUBJECT_CERT 2
- // pvSubject :: PCCERT_CONTEXT
- #define CRYPT_VERIFY_CERT_SIGN_SUBJECT_CRL 3
- // pvSubject :: PCCRL_CONTEXT
- // Issuer Types
- #define CRYPT_VERIFY_CERT_SIGN_ISSUER_PUBKEY 1
- // pvIssuer :: PCERT_PUBLIC_KEY_INFO
- #define CRYPT_VERIFY_CERT_SIGN_ISSUER_CERT 2
- // pvIssuer :: PCCERT_CONTEXT
- #define CRYPT_VERIFY_CERT_SIGN_ISSUER_CHAIN 3
- // pvIssuer :: PCCERT_CHAIN_CONTEXT
- #define CRYPT_VERIFY_CERT_SIGN_ISSUER_NULL 4
- // pvIssuer :: NULL
- //+-------------------------------------------------------------------------
- // Compute the hash of the "to be signed" information in the encoded
- // signed content (CERT_SIGNED_CONTENT_INFO).
- //
- // hCryptProv specifies the crypto provider to use to compute the hash.
- // It doesn't need to use a private key.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptHashToBeSigned(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwCertEncodingType,
- IN const BYTE *pbEncoded,
- IN DWORD cbEncoded,
- OUT BYTE *pbComputedHash,
- IN OUT DWORD *pcbComputedHash
- );
- //+-------------------------------------------------------------------------
- // Hash the encoded content.
- //
- // hCryptProv specifies the crypto provider to use to compute the hash.
- // It doesn't need to use a private key.
- //
- // Algid specifies the CAPI hash algorithm to use. If Algid is 0, then, the
- // default hash algorithm (currently SHA1) is used.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptHashCertificate(
- IN HCRYPTPROV hCryptProv,
- IN ALG_ID Algid,
- IN DWORD dwFlags,
- IN const BYTE *pbEncoded,
- IN DWORD cbEncoded,
- OUT BYTE *pbComputedHash,
- IN OUT DWORD *pcbComputedHash
- );
- //+-------------------------------------------------------------------------
- // Sign the "to be signed" information in the encoded signed content.
- //
- // hCryptProv specifies the crypto provider to use to do the signature.
- // It uses the specified private key.
- //
- // If the SignatureAlgorithm is a hash algorithm, then, the signature
- // contains the hash octets. A private key isn't used to encrypt the hash.
- // dwKeySpec isn't used and hCryptProv can be NULL where an appropriate
- // default provider will be used for hashing.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSignCertificate(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwKeySpec,
- IN DWORD dwCertEncodingType,
- IN const BYTE *pbEncodedToBeSigned,
- IN DWORD cbEncodedToBeSigned,
- IN PCRYPT_ALGORITHM_IDENTIFIER pSignatureAlgorithm,
- IN OPTIONAL const void *pvHashAuxInfo,
- OUT BYTE *pbSignature,
- IN OUT DWORD *pcbSignature
- );
- //+-------------------------------------------------------------------------
- // Encode the "to be signed" information. Sign the encoded "to be signed".
- // Encode the "to be signed" and the signature.
- //
- // hCryptProv specifies the crypto provider to use to do the signature.
- // It uses the specified private key.
- //
- // If the SignatureAlgorithm is a hash algorithm, then, the signature
- // contains the hash octets. A private key isn't used to encrypt the hash.
- // dwKeySpec isn't used and hCryptProv can be NULL where an appropriate
- // default provider will be used for hashing.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSignAndEncodeCertificate(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwKeySpec,
- IN DWORD dwCertEncodingType,
- IN LPCSTR lpszStructType, // "to be signed"
- IN const void *pvStructInfo,
- IN PCRYPT_ALGORITHM_IDENTIFIER pSignatureAlgorithm,
- IN OPTIONAL const void *pvHashAuxInfo,
- OUT PBYTE pbEncoded,
- IN OUT DWORD *pcbEncoded
- );
- //+-------------------------------------------------------------------------
- // Verify the time validity of a certificate.
- //
- // Returns -1 if before NotBefore, +1 if after NotAfter and otherwise 0 for
- // a valid certificate
- //
- // If pTimeToVerify is NULL, uses the current time.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- LONG
- WINAPI
- CertVerifyTimeValidity(
- IN LPFILETIME pTimeToVerify,
- IN PCERT_INFO pCertInfo
- );
- //+-------------------------------------------------------------------------
- // Verify the time validity of a CRL.
- //
- // Returns -1 if before ThisUpdate, +1 if after NextUpdate and otherwise 0 for
- // a valid CRL
- //
- // If pTimeToVerify is NULL, uses the current time.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- LONG
- WINAPI
- CertVerifyCRLTimeValidity(
- IN LPFILETIME pTimeToVerify,
- IN PCRL_INFO pCrlInfo
- );
- //+-------------------------------------------------------------------------
- // Verify that the subject's time validity nests within the issuer's time
- // validity.
- //
- // Returns TRUE if it nests. Otherwise, returns FALSE.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertVerifyValidityNesting(
- IN PCERT_INFO pSubjectInfo,
- IN PCERT_INFO pIssuerInfo
- );
- //+-------------------------------------------------------------------------
- // Verify that the subject certificate isn't on its issuer CRL.
- //
- // Returns true if the certificate isn't on the CRL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertVerifyCRLRevocation(
- IN DWORD dwCertEncodingType,
- IN PCERT_INFO pCertId, // Only the Issuer and SerialNumber
- // fields are used
- IN DWORD cCrlInfo,
- IN PCRL_INFO rgpCrlInfo[]
- );
- //+-------------------------------------------------------------------------
- // Convert the CAPI AlgId to the ASN.1 Object Identifier string
- //
- // Returns NULL if there isn't an ObjId corresponding to the AlgId.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- LPCSTR
- WINAPI
- CertAlgIdToOID(
- IN DWORD dwAlgId
- );
- //+-------------------------------------------------------------------------
- // Convert the ASN.1 Object Identifier string to the CAPI AlgId.
- //
- // Returns 0 if there isn't an AlgId corresponding to the ObjId.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertOIDToAlgId(
- IN LPCSTR pszObjId
- );
- //+-------------------------------------------------------------------------
- // Find an extension identified by its Object Identifier.
- //
- // If found, returns pointer to the extension. Otherwise, returns NULL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCERT_EXTENSION
- WINAPI
- CertFindExtension(
- IN LPCSTR pszObjId,
- IN DWORD cExtensions,
- IN CERT_EXTENSION rgExtensions[]
- );
- //+-------------------------------------------------------------------------
- // Find the first attribute identified by its Object Identifier.
- //
- // If found, returns pointer to the attribute. Otherwise, returns NULL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCRYPT_ATTRIBUTE
- WINAPI
- CertFindAttribute(
- IN LPCSTR pszObjId,
- IN DWORD cAttr,
- IN CRYPT_ATTRIBUTE rgAttr[]
- );
- //+-------------------------------------------------------------------------
- // Find the first CERT_RDN attribute identified by its Object Identifier in
- // the name's list of Relative Distinguished Names.
- //
- // If found, returns pointer to the attribute. Otherwise, returns NULL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCERT_RDN_ATTR
- WINAPI
- CertFindRDNAttr(
- IN LPCSTR pszObjId,
- IN PCERT_NAME_INFO pName
- );
- //+-------------------------------------------------------------------------
- // Get the intended key usage bytes from the certificate.
- //
- // If the certificate doesn't have any intended key usage bytes, returns FALSE
- // and *pbKeyUsage is zeroed. Otherwise, returns TRUE and up through
- // cbKeyUsage bytes are copied into *pbKeyUsage. Any remaining uncopied
- // bytes are zeroed.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetIntendedKeyUsage(
- IN DWORD dwCertEncodingType,
- IN PCERT_INFO pCertInfo,
- OUT BYTE *pbKeyUsage,
- IN DWORD cbKeyUsage
- );
- typedef void *HCRYPTDEFAULTCONTEXT;
- //+-------------------------------------------------------------------------
- // Install a previously CryptAcquiredContext'ed HCRYPTPROV to be used as
- // a default context.
- //
- // dwDefaultType and pvDefaultPara specify where the default context is used.
- // For example, install the HCRYPTPROV to be used to verify certificate's
- // having szOID_OIWSEC_md5RSA signatures.
- //
- // By default, the installed HCRYPTPROV is only applicable to the current
- // thread. Set CRYPT_DEFAULT_CONTEXT_PROCESS_FLAG to allow the HCRYPTPROV
- // to be used by all threads in the current process.
- //
- // For a successful install, TRUE is returned and *phDefaultContext is
- // updated with the HANDLE to be passed to CryptUninstallDefaultContext.
- //
- // The installed HCRYPTPROVs are stack ordered (the last installed
- // HCRYPTPROV is checked first). All thread installed HCRYPTPROVs are
- // checked before any process HCRYPTPROVs.
- //
- // The installed HCRYPTPROV remains available for default usage until
- // CryptUninstallDefaultContext is called or the thread or process exits.
- //
- // If CRYPT_DEFAULT_CONTEXT_AUTO_RELEASE_FLAG is set, then, the HCRYPTPROV
- // is CryptReleaseContext'ed at thread or process exit. However,
- // not CryptReleaseContext'ed if CryptUninstallDefaultContext is
- // called.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptInstallDefaultContext(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwDefaultType,
- IN const void *pvDefaultPara,
- IN DWORD dwFlags,
- IN void *pvReserved,
- OUT HCRYPTDEFAULTCONTEXT *phDefaultContext
- );
- // dwFlags
- #define CRYPT_DEFAULT_CONTEXT_AUTO_RELEASE_FLAG 0x00000001
- #define CRYPT_DEFAULT_CONTEXT_PROCESS_FLAG 0x00000002
- // List of dwDefaultType's
- #define CRYPT_DEFAULT_CONTEXT_CERT_SIGN_OID 1
- #define CRYPT_DEFAULT_CONTEXT_MULTI_CERT_SIGN_OID 2
- //+-------------------------------------------------------------------------
- // CRYPT_DEFAULT_CONTEXT_CERT_SIGN_OID
- //
- // Install a default HCRYPTPROV used to verify a certificate
- // signature. pvDefaultPara points to the szOID of the certificate
- // signature algorithm, for example, szOID_OIWSEC_md5RSA. If
- // pvDefaultPara is NULL, then, the HCRYPTPROV is used to verify all
- // certificate signatures. Note, pvDefaultPara can't be NULL when
- // CRYPT_DEFAULT_CONTEXT_PROCESS_FLAG is set.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CRYPT_DEFAULT_CONTEXT_MULTI_CERT_SIGN_OID
- //
- // Same as CRYPT_DEFAULT_CONTEXT_CERT_SIGN_OID. However, the default
- // HCRYPTPROV is to be used for multiple signature szOIDs. pvDefaultPara
- // points to a CRYPT_DEFAULT_CONTEXT_MULTI_OID_PARA structure containing
- // an array of szOID pointers.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_DEFAULT_CONTEXT_MULTI_OID_PARA {
- DWORD cOID;
- LPSTR *rgpszOID;
- } CRYPT_DEFAULT_CONTEXT_MULTI_OID_PARA, *PCRYPT_DEFAULT_CONTEXT_MULTI_OID_PARA;
- //+-------------------------------------------------------------------------
- // Uninstall a default context previously installed by
- // CryptInstallDefaultContext.
- //
- // For a default context installed with CRYPT_DEFAULT_CONTEXT_PROCESS_FLAG
- // set, if any other threads are currently using this context,
- // this function will block until they finish.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptUninstallDefaultContext(
- HCRYPTDEFAULTCONTEXT hDefaultContext,
- IN DWORD dwFlags,
- IN void *pvReserved
- );
- //+-------------------------------------------------------------------------
- // Export the public key info associated with the provider's corresponding
- // private key.
- //
- // Calls CryptExportPublicKeyInfoEx with pszPublicKeyObjId = NULL,
- // dwFlags = 0 and pvAuxInfo = NULL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptExportPublicKeyInfo(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwKeySpec,
- IN DWORD dwCertEncodingType,
- OUT PCERT_PUBLIC_KEY_INFO pInfo,
- IN OUT DWORD *pcbInfo
- );
- //+-------------------------------------------------------------------------
- // Export the public key info associated with the provider's corresponding
- // private key.
- //
- // Uses the dwCertEncodingType and pszPublicKeyObjId to call the
- // installable CRYPT_OID_EXPORT_PUBLIC_KEY_INFO_FUNC. The called function
- // has the same signature as CryptExportPublicKeyInfoEx.
- //
- // If unable to find an installable OID function for the pszPublicKeyObjId,
- // attempts to export as a RSA Public Key (szOID_RSA_RSA).
- //
- // The dwFlags and pvAuxInfo aren't used for szOID_RSA_RSA.
- //--------------------------------------------------------------------------
- #define CRYPT_OID_EXPORT_PUBLIC_KEY_INFO_FUNC "CryptDllExportPublicKeyInfoEx"
- WINCRYPT32API
- BOOL
- WINAPI
- CryptExportPublicKeyInfoEx(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwKeySpec,
- IN DWORD dwCertEncodingType,
- IN LPSTR pszPublicKeyObjId,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvAuxInfo,
- OUT PCERT_PUBLIC_KEY_INFO pInfo,
- IN OUT DWORD *pcbInfo
- );
- //+-------------------------------------------------------------------------
- // Convert and import the public key info into the provider and return a
- // handle to the public key.
- //
- // Calls CryptImportPublicKeyInfoEx with aiKeyAlg = 0, dwFlags = 0 and
- // pvAuxInfo = NULL.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptImportPublicKeyInfo(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwCertEncodingType,
- IN PCERT_PUBLIC_KEY_INFO pInfo,
- OUT HCRYPTKEY *phKey
- );
- //+-------------------------------------------------------------------------
- // Convert and import the public key info into the provider and return a
- // handle to the public key.
- //
- // Uses the dwCertEncodingType and pInfo->Algorithm.pszObjId to call the
- // installable CRYPT_OID_IMPORT_PUBLIC_KEY_INFO_FUNC. The called function
- // has the same signature as CryptImportPublicKeyInfoEx.
- //
- // If unable to find an installable OID function for the pszObjId,
- // attempts to import as a RSA Public Key (szOID_RSA_RSA).
- //
- // For szOID_RSA_RSA: aiKeyAlg may be set to CALG_RSA_SIGN or CALG_RSA_KEYX.
- // Defaults to CALG_RSA_KEYX. The dwFlags and pvAuxInfo aren't used.
- //--------------------------------------------------------------------------
- #define CRYPT_OID_IMPORT_PUBLIC_KEY_INFO_FUNC "CryptDllImportPublicKeyInfoEx"
- WINCRYPT32API
- BOOL
- WINAPI
- CryptImportPublicKeyInfoEx(
- IN HCRYPTPROV hCryptProv,
- IN DWORD dwCertEncodingType,
- IN PCERT_PUBLIC_KEY_INFO pInfo,
- IN ALG_ID aiKeyAlg,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvAuxInfo,
- OUT HCRYPTKEY *phKey
- );
- //+-------------------------------------------------------------------------
- // Acquire a HCRYPTPROV handle and dwKeySpec for the specified certificate
- // context. Uses the certificate's CERT_KEY_PROV_INFO_PROP_ID property.
- // The returned HCRYPTPROV handle may optionally be cached using the
- // certificate's CERT_KEY_CONTEXT_PROP_ID property.
- //
- // If CRYPT_ACQUIRE_CACHE_FLAG is set, then, if an already acquired and
- // cached HCRYPTPROV exists for the certificate, its returned. Otherwise,
- // a HCRYPTPROV is acquired and then cached via the certificate's
- // CERT_KEY_CONTEXT_PROP_ID.
- //
- // The CRYPT_ACQUIRE_USE_PROV_INFO_FLAG can be set to use the dwFlags field of
- // the certificate's CERT_KEY_PROV_INFO_PROP_ID property's CRYPT_KEY_PROV_INFO
- // data structure to determine if the returned HCRYPTPROV should be cached.
- // HCRYPTPROV caching is enabled if the CERT_SET_KEY_CONTEXT_PROP_ID flag was
- // set.
- //
- // If CRYPT_ACQUIRE_COMPARE_KEY_FLAG is set, then,
- // the public key in the certificate is compared with the public
- // key returned by the cryptographic provider. If the keys don't match, the
- // acquire fails and LastError is set to NTE_BAD_PUBLIC_KEY. Note, if
- // a cached HCRYPTPROV is returned, the comparison isn't done. We assume the
- // comparison was done on the initial acquire.
- //
- // The CRYPT_ACQUIRE_SILENT_FLAG can be set to suppress any UI by the CSP.
- // See CryptAcquireContext's CRYPT_SILENT flag for more details.
- //
- // *pfCallerFreeProv is returned set to FALSE for:
- // - Acquire or public key comparison fails.
- // - CRYPT_ACQUIRE_CACHE_FLAG is set.
- // - CRYPT_ACQUIRE_USE_PROV_INFO_FLAG is set AND
- // CERT_SET_KEY_CONTEXT_PROP_ID flag is set in the dwFlags field of the
- // certificate's CERT_KEY_PROV_INFO_PROP_ID property's
- // CRYPT_KEY_PROV_INFO data structure.
- // When *pfCallerFreeProv is FALSE, the caller must not release. The
- // returned HCRYPTPROV will be released on the last free of the certificate
- // context.
- //
- // Otherwise, *pfCallerFreeProv is TRUE and the returned HCRYPTPROV must
- // be released by the caller by calling CryptReleaseContext.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptAcquireCertificatePrivateKey(
- IN PCCERT_CONTEXT pCert,
- IN DWORD dwFlags,
- IN void *pvReserved,
- OUT HCRYPTPROV *phCryptProv,
- OUT OPTIONAL DWORD *pdwKeySpec,
- OUT OPTIONAL BOOL *pfCallerFreeProv
- );
- #define CRYPT_ACQUIRE_CACHE_FLAG 0x00000001
- #define CRYPT_ACQUIRE_USE_PROV_INFO_FLAG 0x00000002
- #define CRYPT_ACQUIRE_COMPARE_KEY_FLAG 0x00000004
- #define CRYPT_ACQUIRE_SILENT_FLAG 0x00000040
- //+-------------------------------------------------------------------------
- // Enumerates the cryptographic providers and their containers to find the
- // private key corresponding to the certificate's public key. For a match,
- // the certificate's CERT_KEY_PROV_INFO_PROP_ID property is updated.
- //
- // If the CERT_KEY_PROV_INFO_PROP_ID is already set, then, its checked to
- // see if it matches the provider's public key. For a match, the above
- // enumeration is skipped.
- //
- // By default both the user and machine key containers are searched.
- // The CRYPT_FIND_USER_KEYSET_FLAG or CRYPT_FIND_MACHINE_KEYSET_FLAG
- // can be set in dwFlags to restrict the search to either of the containers.
- //
- // The CRYPT_FIND_SILENT_KEYSET_FLAG can be set to suppress any UI by the CSP.
- // See CryptAcquireContext's CRYPT_SILENT flag for more details.
- //
- // If a container isn't found, returns FALSE with LastError set to
- // NTE_NO_KEY.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptFindCertificateKeyProvInfo(
- IN PCCERT_CONTEXT pCert,
- IN DWORD dwFlags,
- IN void *pvReserved
- );
- #define CRYPT_FIND_USER_KEYSET_FLAG 0x00000001
- #define CRYPT_FIND_MACHINE_KEYSET_FLAG 0x00000002
- #define CRYPT_FIND_SILENT_KEYSET_FLAG 0x00000040
- //+-------------------------------------------------------------------------
- // This is the prototype for the installable function which is called to
- // actually import a key into a CSP. an installable of this type is called
- // from CryptImportPKCS8. the algorithm OID of the private key is used
- // to look up the proper installable function to call.
- //
- // hCryptProv - the provider to import the key to
- // pPrivateKeyInfo - describes the key to be imported
- // dwFlags - The available flags are:
- // CRYPT_EXPORTABLE
- // this flag is used when importing private keys, for a full
- // explanation please see the documentation for CryptImportKey.
- // pvAuxInfo - reserved for future, must be NULL
- //--------------------------------------------------------------------------
- typedef BOOL (WINAPI *PFN_IMPORT_PRIV_KEY_FUNC) (
- HCRYPTPROV hCryptProv, // in
- CRYPT_PRIVATE_KEY_INFO *pPrivateKeyInfo, // in
- DWORD dwFlags, // in, optional
- void *pvAuxInfo // in, optional
- );
- #define CRYPT_OID_IMPORT_PRIVATE_KEY_INFO_FUNC "CryptDllImportPrivateKeyInfoEx"
- //+-------------------------------------------------------------------------
- // Convert (from PKCS8 format) and import the private key into a provider
- // and return a handle to the provider as well as the KeySpec used to import to.
- //
- // This function will call the PRESOLVE_HCRYPTPROV_FUNC in the
- // privateKeyAndParams to obtain a handle of provider to import the key to.
- // if the PRESOLVE_HCRYPTPROV_FUNC is NULL then the default provider will be used.
- //
- // privateKeyAndParams - private key blob and corresponding parameters
- // dwFlags - The available flags are:
- // CRYPT_EXPORTABLE
- // this flag is used when importing private keys, for a full
- // explanation please see the documentation for CryptImportKey.
- // phCryptProv - filled in with the handle of the provider the key was
- // imported to, the caller is responsible for freeing it
- // pvAuxInfo - This parameter is reserved for future use and should be set
- // to NULL in the interim.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptImportPKCS8(
- CRYPT_PKCS8_IMPORT_PARAMS sImportParams, // in
- DWORD dwFlags, // in, optional
- HCRYPTPROV *phCryptProv, // out, optional
- void *pvAuxInfo // in, optional
- );
- //+-------------------------------------------------------------------------
- // this is the prototype for installable functions for exporting the private key
- //--------------------------------------------------------------------------
- typedef BOOL (WINAPI *PFN_EXPORT_PRIV_KEY_FUNC) (
- HCRYPTPROV hCryptProv, // in
- DWORD dwKeySpec, // in
- LPSTR pszPrivateKeyObjId, // in
- DWORD dwFlags, // in
- void *pvAuxInfo, // in
- CRYPT_PRIVATE_KEY_INFO *pPrivateKeyInfo, // out
- DWORD *pcbPrivateKeyBlob // in, out
- );
- #define CRYPT_OID_EXPORT_PRIVATE_KEY_INFO_FUNC "CryptDllExportPrivateKeyInfoEx"
- #define CRYPT_DELETE_KEYSET 0x0001
- //+-------------------------------------------------------------------------
- // CryptExportPKCS8 -- superseded by CryptExportPKCS8Ex
- //
- // Export the private key in PKCS8 format
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptExportPKCS8(
- HCRYPTPROV hCryptProv, // in
- DWORD dwKeySpec, // in
- LPSTR pszPrivateKeyObjId, // in
- DWORD dwFlags, // in
- void *pvAuxInfo, // in
- BYTE *pbPrivateKeyBlob, // out
- DWORD *pcbPrivateKeyBlob // in, out
- );
- //+-------------------------------------------------------------------------
- // CryptExportPKCS8Ex
- //
- // Export the private key in PKCS8 format
- //
- //
- // Uses the pszPrivateKeyObjId to call the
- // installable CRYPT_OID_EXPORT_PRIVATE_KEY_INFO_FUNC. The called function
- // has the signature defined by PFN_EXPORT_PRIV_KEY_FUNC.
- //
- // If unable to find an installable OID function for the pszPrivateKeyObjId,
- // attempts to export as a RSA Private Key (szOID_RSA_RSA).
- //
- // psExportParams - specifies information about the key to export
- // dwFlags - The flag values. None currently supported
- // pvAuxInfo - This parameter is reserved for future use and should be set to
- // NULL in the interim.
- // pbPrivateKeyBlob - A pointer to the private key blob. It will be encoded
- // as a PKCS8 PrivateKeyInfo.
- // pcbPrivateKeyBlob - A pointer to a DWORD that contains the size, in bytes,
- // of the private key blob being exported.
- //+-------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptExportPKCS8Ex(
- CRYPT_PKCS8_EXPORT_PARAMS* psExportParams, // in
- DWORD dwFlags, // in
- void *pvAuxInfo, // in
- BYTE *pbPrivateKeyBlob, // out
- DWORD *pcbPrivateKeyBlob // in, out
- );
- //+-------------------------------------------------------------------------
- // Compute the hash of the encoded public key info.
- //
- // The public key info is encoded and then hashed.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptHashPublicKeyInfo(
- IN HCRYPTPROV hCryptProv,
- IN ALG_ID Algid,
- IN DWORD dwFlags,
- IN DWORD dwCertEncodingType,
- IN PCERT_PUBLIC_KEY_INFO pInfo,
- OUT BYTE *pbComputedHash,
- IN OUT DWORD *pcbComputedHash
- );
- //+-------------------------------------------------------------------------
- // Convert a Name Value to a null terminated char string
- //
- // Returns the number of characters converted including the terminating null
- // character. If psz is NULL or csz is 0, returns the required size of the
- // destination string (including the terminating null char).
- //
- // If psz != NULL && csz != 0, returned psz is always NULL terminated.
- //
- // Note: csz includes the NULL char.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertRDNValueToStrA(
- IN DWORD dwValueType,
- IN PCERT_RDN_VALUE_BLOB pValue,
- OUT OPTIONAL LPSTR psz,
- IN DWORD csz
- );
- //+-------------------------------------------------------------------------
- // Convert a Name Value to a null terminated char string
- //
- // Returns the number of characters converted including the terminating null
- // character. If psz is NULL or csz is 0, returns the required size of the
- // destination string (including the terminating null char).
- //
- // If psz != NULL && csz != 0, returned psz is always NULL terminated.
- //
- // Note: csz includes the NULL char.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertRDNValueToStrW(
- IN DWORD dwValueType,
- IN PCERT_RDN_VALUE_BLOB pValue,
- OUT OPTIONAL LPWSTR psz,
- IN DWORD csz
- );
- #ifdef UNICODE
- #define CertRDNValueToStr CertRDNValueToStrW
- #else
- #define CertRDNValueToStr CertRDNValueToStrA
- #endif // !UNICODE
- //+-------------------------------------------------------------------------
- // Convert the certificate name blob to a null terminated char string.
- //
- // Follows the string representation of distinguished names specified in
- // RFC 1779. (Note, added double quoting "" for embedded quotes, quote
- // empty strings and don't quote strings containing consecutive spaces).
- // RDN values of type CERT_RDN_ENCODED_BLOB or CERT_RDN_OCTET_STRING are
- // formatted in hexadecimal (e.g. #0A56CF).
- //
- // The name string is formatted according to the dwStrType:
- // CERT_SIMPLE_NAME_STR
- // The object identifiers are discarded. CERT_RDN entries are separated
- // by ", ". Multiple attributes per CERT_RDN are separated by " + ".
- // For example:
- // Microsoft, Joe Cool + Programmer
- // CERT_OID_NAME_STR
- // The object identifiers are included with a "=" separator from their
- // attribute value. CERT_RDN entries are separated by ", ".
- // Multiple attributes per CERT_RDN are separated by " + ". For example:
- // 2.5.4.11=Microsoft, 2.5.4.3=Joe Cool + 2.5.4.12=Programmer
- // CERT_X500_NAME_STR
- // The object identifiers are converted to their X500 key name. Otherwise,
- // same as CERT_OID_NAME_STR. If the object identifier doesn't have
- // a corresponding X500 key name, then, the object identifier is used with
- // a "OID." prefix. For example:
- // OU=Microsoft, CN=Joe Cool + T=Programmer, OID.1.2.3.4.5.6=Unknown
- //
- // We quote the RDN value if it contains leading or trailing whitespace
- // or one of the following characters: ",", "+", "=", """, "\n", "<", ">",
- // "#" or ";". The quoting character is ". If the the RDN Value contains
- // a " it is double quoted (""). For example:
- // OU=" Microsoft", CN="Joe ""Cool""" + T="Programmer, Manager"
- //
- // CERT_NAME_STR_SEMICOLON_FLAG can be or'ed into dwStrType to replace
- // the ", " separator with a "; " separator.
- //
- // CERT_NAME_STR_CRLF_FLAG can be or'ed into dwStrType to replace
- // the ", " separator with a "\r\n" separator.
- //
- // CERT_NAME_STR_NO_PLUS_FLAG can be or'ed into dwStrType to replace the
- // " + " separator with a single space, " ".
- //
- // CERT_NAME_STR_NO_QUOTING_FLAG can be or'ed into dwStrType to inhibit
- // the above quoting.
- //
- // CERT_NAME_STR_REVERSE_FLAG can be or'ed into dwStrType to reverse the
- // order of the RDNs before converting to the string.
- //
- // By default, CERT_RDN_T61_STRING encoded values are initially decoded
- // as UTF8. If the UTF8 decoding fails, then, decoded as 8 bit characters.
- // CERT_NAME_STR_DISABLE_IE4_UTF8_FLAG can be or'ed into dwStrType to
- // skip the initial attempt to decode as UTF8.
- //
- // Returns the number of characters converted including the terminating null
- // character. If psz is NULL or csz is 0, returns the required size of the
- // destination string (including the terminating null char).
- //
- // If psz != NULL && csz != 0, returned psz is always NULL terminated.
- //
- // Note: csz includes the NULL char.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertNameToStrA(
- IN DWORD dwCertEncodingType,
- IN PCERT_NAME_BLOB pName,
- IN DWORD dwStrType,
- OUT OPTIONAL LPSTR psz,
- IN DWORD csz
- );
- //+-------------------------------------------------------------------------
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertNameToStrW(
- IN DWORD dwCertEncodingType,
- IN PCERT_NAME_BLOB pName,
- IN DWORD dwStrType,
- OUT OPTIONAL LPWSTR psz,
- IN DWORD csz
- );
- #ifdef UNICODE
- #define CertNameToStr CertNameToStrW
- #else
- #define CertNameToStr CertNameToStrA
- #endif // !UNICODE
- //+-------------------------------------------------------------------------
- // Certificate name string types
- //--------------------------------------------------------------------------
- #define CERT_SIMPLE_NAME_STR 1
- #define CERT_OID_NAME_STR 2
- #define CERT_X500_NAME_STR 3
- //+-------------------------------------------------------------------------
- // Certificate name string type flags OR'ed with the above types
- //--------------------------------------------------------------------------
- #define CERT_NAME_STR_SEMICOLON_FLAG 0x40000000
- #define CERT_NAME_STR_NO_PLUS_FLAG 0x20000000
- #define CERT_NAME_STR_NO_QUOTING_FLAG 0x10000000
- #define CERT_NAME_STR_CRLF_FLAG 0x08000000
- #define CERT_NAME_STR_COMMA_FLAG 0x04000000
- #define CERT_NAME_STR_REVERSE_FLAG 0x02000000
- #define CERT_NAME_STR_DISABLE_IE4_UTF8_FLAG 0x00010000
- #define CERT_NAME_STR_ENABLE_T61_UNICODE_FLAG 0x00020000
- #define CERT_NAME_STR_ENABLE_UTF8_UNICODE_FLAG 0x00040000
- //+-------------------------------------------------------------------------
- // Convert the null terminated X500 string to an encoded certificate name.
- //
- // The input string is expected to be formatted the same as the output
- // from the above CertNameToStr API.
- //
- // The CERT_SIMPLE_NAME_STR type isn't supported. Otherwise, when dwStrType
- // is set to 0, CERT_OID_NAME_STR or CERT_X500_NAME_STR, allow either a
- // case insensitive X500 key (CN=), case insensitive "OID." prefixed
- // object identifier (OID.1.2.3.4.5.6=) or an object identifier (1.2.3.4=).
- //
- // If no flags are OR'ed into dwStrType, then, allow "," or ";" as RDN
- // separators and "+" as the multiple RDN value separator. Quoting is
- // supported. A quote may be included in a quoted value by double quoting,
- // for example (CN="Joe ""Cool"""). A value starting with a "#" is treated
- // as ascii hex and converted to a CERT_RDN_OCTET_STRING. Embedded whitespace
- // is skipped (1.2.3 = # AB CD 01 is the same as 1.2.3=#ABCD01).
- //
- // Whitespace surrounding the keys, object identifers and values is removed.
- //
- // CERT_NAME_STR_COMMA_FLAG can be or'ed into dwStrType to only allow the
- // "," as the RDN separator.
- //
- // CERT_NAME_STR_SEMICOLON_FLAG can be or'ed into dwStrType to only allow the
- // ";" as the RDN separator.
- //
- // CERT_NAME_STR_CRLF_FLAG can be or'ed into dwStrType to only allow
- // "\r" or "\n" as the RDN separator.
- //
- // CERT_NAME_STR_NO_PLUS_FLAG can be or'ed into dwStrType to ignore "+"
- // as a separator and not allow multiple values per RDN.
- //
- // CERT_NAME_STR_NO_QUOTING_FLAG can be or'ed into dwStrType to inhibit
- // quoting.
- //
- // CERT_NAME_STR_REVERSE_FLAG can be or'ed into dwStrType to reverse the
- // order of the RDNs after converting from the string and before encoding.
- //
- // CERT_NAME_STR_ENABLE_T61_UNICODE_FLAG can be or'ed into dwStrType to
- // to select the CERT_RDN_T61_STRING encoded value type instead of
- // CERT_RDN_UNICODE_STRING if all the UNICODE characters are <= 0xFF.
- //
- // CERT_NAME_STR_ENABLE_UTF8_UNICODE_FLAG can be or'ed into dwStrType to
- // to select the CERT_RDN_UTF8_STRING encoded value type instead of
- // CERT_RDN_UNICODE_STRING.
- //
- // Support the following X500 Keys:
- //
- // Key Object Identifier RDN Value Type(s)
- // --- ----------------- -----------------
- // CN szOID_COMMON_NAME Printable, Unicode
- // L szOID_LOCALITY_NAME Printable, Unicode
- // O szOID_ORGANIZATION_NAME Printable, Unicode
- // OU szOID_ORGANIZATIONAL_UNIT_NAME Printable, Unicode
- // E szOID_RSA_emailAddr Only IA5
- // Email szOID_RSA_emailAddr Only IA5
- // C szOID_COUNTRY_NAME Only Printable
- // S szOID_STATE_OR_PROVINCE_NAME Printable, Unicode
- // ST szOID_STATE_OR_PROVINCE_NAME Printable, Unicode
- // STREET szOID_STREET_ADDRESS Printable, Unicode
- // T szOID_TITLE Printable, Unicode
- // Title szOID_TITLE Printable, Unicode
- // G szOID_GIVEN_NAME Printable, Unicode
- // GivenName szOID_GIVEN_NAME Printable, Unicode
- // I szOID_INITIALS Printable, Unicode
- // Initials szOID_INITIALS Printable, Unicode
- // SN szOID_SUR_NAME Printable, Unicode
- // DC szOID_DOMAIN_COMPONENT IA5, UTF8
- //
- // Note, T61 is selected instead of Unicode if
- // CERT_NAME_STR_ENABLE_T61_UNICODE_FLAG is set and all the unicode
- // characters are <= 0xFF.
- //
- // Note, UTF8 is selected instead of Unicode if
- // CERT_NAME_STR_ENABLE_UTF8_UNICODE_FLAG is set.
- //
- // Returns TRUE if successfully parsed the input string and encoded
- // the name.
- //
- // If the input string is detected to be invalid, *ppszError is updated
- // to point to the beginning of the invalid character sequence. Otherwise,
- // *ppszError is set to NULL. *ppszError is updated with a non-NULL pointer
- // for the following errors:
- // CRYPT_E_INVALID_X500_STRING
- // CRYPT_E_INVALID_NUMERIC_STRING
- // CRYPT_E_INVALID_PRINTABLE_STRING
- // CRYPT_E_INVALID_IA5_STRING
- //
- // ppszError can be set to NULL if not interested in getting a pointer
- // to the invalid character sequence.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertStrToNameA(
- IN DWORD dwCertEncodingType,
- IN LPCSTR pszX500,
- IN DWORD dwStrType,
- IN OPTIONAL void *pvReserved,
- OUT BYTE *pbEncoded,
- IN OUT DWORD *pcbEncoded,
- OUT OPTIONAL LPCSTR *ppszError
- );
- //+-------------------------------------------------------------------------
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertStrToNameW(
- IN DWORD dwCertEncodingType,
- IN LPCWSTR pszX500,
- IN DWORD dwStrType,
- IN OPTIONAL void *pvReserved,
- OUT BYTE *pbEncoded,
- IN OUT DWORD *pcbEncoded,
- OUT OPTIONAL LPCWSTR *ppszError
- );
- #ifdef UNICODE
- #define CertStrToName CertStrToNameW
- #else
- #define CertStrToName CertStrToNameA
- #endif // !UNICODE
- //+-------------------------------------------------------------------------
- // Get the subject or issuer name from the certificate and
- // according to the specified format type, convert to a null terminated
- // character string.
- //
- // CERT_NAME_ISSUER_FLAG can be set to get the issuer's name. Otherwise,
- // gets the subject's name.
- //
- // By default, CERT_RDN_T61_STRING encoded values are initially decoded
- // as UTF8. If the UTF8 decoding fails, then, decoded as 8 bit characters.
- // CERT_NAME_DISABLE_IE4_UTF8_FLAG can be set in dwFlags to
- // skip the initial attempt to decode as UTF8.
- //
- // The name string is formatted according to the dwType:
- // CERT_NAME_EMAIL_TYPE
- // If the certificate has a Subject Alternative Name extension (for
- // issuer, Issuer Alternative Name), searches for first rfc822Name choice.
- // If the rfc822Name choice isn't found in the extension, searches the
- // Subject Name field for the Email OID, "1.2.840.113549.1.9.1".
- // If the rfc822Name or Email OID is found, returns the string. Otherwise,
- // returns an empty string (returned character count is 1).
- // CERT_NAME_DNS_TYPE
- // If the certificate has a Subject Alternative Name extension (for
- // issuer, Issuer Alternative Name), searches for first DNSName choice.
- // If the DNSName choice isn't found in the extension, searches the
- // Subject Name field for the CN OID, "2.5.4.3".
- // If the DNSName or CN OID is found, returns the string. Otherwise,
- // returns an empty string.
- // CERT_NAME_URL_TYPE
- // If the certificate has a Subject Alternative Name extension (for
- // issuer, Issuer Alternative Name), searches for first URL choice.
- // If the URL choice is found, returns the string. Otherwise,
- // returns an empty string.
- // CERT_NAME_UPN_TYPE
- // If the certificate has a Subject Alternative Name extension,
- // searches the OtherName choices looking for a
- // pszObjId == szOID_NT_PRINCIPAL_NAME, "1.3.6.1.4.1.311.20.2.3".
- // If the UPN OID is found, the blob is decoded as a
- // X509_UNICODE_ANY_STRING and the decoded string is returned.
- // Otherwise, returns an empty string.
- // CERT_NAME_RDN_TYPE
- // Converts the Subject Name blob by calling CertNameToStr. pvTypePara
- // points to a DWORD containing the dwStrType passed to CertNameToStr.
- // If the Subject Name field is empty and the certificate has a
- // Subject Alternative Name extension, searches for and converts
- // the first directoryName choice.
- // CERT_NAME_ATTR_TYPE
- // pvTypePara points to the Object Identifier specifying the name attribute
- // to be returned. For example, to get the CN,
- // pvTypePara = szOID_COMMON_NAME ("2.5.4.3"). Searches, the Subject Name
- // field for the attribute.
- // If the Subject Name field is empty and the certificate has a
- // Subject Alternative Name extension, checks for
- // the first directoryName choice and searches it.
- //
- // Note, searches the RDNs in reverse order.
- //
- // CERT_NAME_SIMPLE_DISPLAY_TYPE
- // Iterates through the following list of name attributes and searches
- // the Subject Name and then the Subject Alternative Name extension
- // for the first occurrence of:
- // szOID_COMMON_NAME ("2.5.4.3")
- // szOID_ORGANIZATIONAL_UNIT_NAME ("2.5.4.11")
- // szOID_ORGANIZATION_NAME ("2.5.4.10")
- // szOID_RSA_emailAddr ("1.2.840.113549.1.9.1")
- //
- // If none of the above attributes is found, then, searches the
- // Subject Alternative Name extension for a rfc822Name choice.
- //
- // If still no match, then, returns the first attribute.
- //
- // Note, like CERT_NAME_ATTR_TYPE, searches the RDNs in reverse order.
- //
- // CERT_NAME_FRIENDLY_DISPLAY_TYPE
- // First checks if the certificate has a CERT_FRIENDLY_NAME_PROP_ID
- // property. If it does, then, this property is returned. Otherwise,
- // returns the above CERT_NAME_SIMPLE_DISPLAY_TYPE.
- //
- // Returns the number of characters converted including the terminating null
- // character. If pwszNameString is NULL or cchNameString is 0, returns the
- // required size of the destination string (including the terminating null
- // char). If the specified name type isn't found. returns an empty string
- // with a returned character count of 1.
- //
- // If pwszNameString != NULL && cwszNameString != 0, returned pwszNameString
- // is always NULL terminated.
- //
- // Note: cchNameString includes the NULL char.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertGetNameStringA(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwType,
- IN DWORD dwFlags,
- IN void *pvTypePara,
- OUT OPTIONAL LPSTR pszNameString,
- IN DWORD cchNameString
- );
- //+-------------------------------------------------------------------------
- //--------------------------------------------------------------------------
- WINCRYPT32API
- DWORD
- WINAPI
- CertGetNameStringW(
- IN PCCERT_CONTEXT pCertContext,
- IN DWORD dwType,
- IN DWORD dwFlags,
- IN void *pvTypePara,
- OUT OPTIONAL LPWSTR pszNameString,
- IN DWORD cchNameString
- );
- #ifdef UNICODE
- #define CertGetNameString CertGetNameStringW
- #else
- #define CertGetNameString CertGetNameStringA
- #endif // !UNICODE
- //+-------------------------------------------------------------------------
- // Certificate name types
- //--------------------------------------------------------------------------
- #define CERT_NAME_EMAIL_TYPE 1
- #define CERT_NAME_RDN_TYPE 2
- #define CERT_NAME_ATTR_TYPE 3
- #define CERT_NAME_SIMPLE_DISPLAY_TYPE 4
- #define CERT_NAME_FRIENDLY_DISPLAY_TYPE 5
- #define CERT_NAME_DNS_TYPE 6
- #define CERT_NAME_URL_TYPE 7
- #define CERT_NAME_UPN_TYPE 8
- //+-------------------------------------------------------------------------
- // Certificate name flags
- //--------------------------------------------------------------------------
- #define CERT_NAME_ISSUER_FLAG 0x1
- #define CERT_NAME_DISABLE_IE4_UTF8_FLAG 0x00010000
- //+=========================================================================
- // Simplified Cryptographic Message Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Conventions for the *pb and *pcb output parameters:
- //
- // Upon entry to the function:
- // if pcb is OPTIONAL && pcb == NULL, then,
- // No output is returned
- // else if pb == NULL && pcb != NULL, then,
- // Length only determination. No length error is
- // returned.
- // otherwise where (pb != NULL && pcb != NULL && *pcb != 0)
- // Output is returned. If *pcb isn't big enough a
- // length error is returned. In all cases *pcb is updated
- // with the actual length needed/returned.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Type definitions of the parameters used for doing the cryptographic
- // operations.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // Callback to get and verify the signer's certificate.
- //
- // Passed the CertId of the signer (its Issuer and SerialNumber) and a
- // handle to its cryptographic signed message's cert store.
- //
- // For CRYPT_E_NO_SIGNER, called with pSignerId == NULL.
- //
- // For a valid signer certificate, returns a pointer to a read only
- // CERT_CONTEXT. The returned CERT_CONTEXT is either obtained from a
- // cert store or was created via CertCreateCertificateContext. For either case,
- // its freed via CertFreeCertificateContext.
- //
- // If a valid certificate isn't found, this callback returns NULL with
- // LastError set via SetLastError().
- //
- // The NULL implementation tries to get the Signer certificate from the
- // message cert store. It doesn't verify the certificate.
- //
- // Note, if the KEYID choice was selected for a CMS SignerId, then, the
- // SerialNumber is 0 and the Issuer is encoded containing a single RDN with a
- // single Attribute whose OID is szOID_KEYID_RDN, value type is
- // CERT_RDN_OCTET_STRING and value is the KEYID. When the
- // CertGetSubjectCertificateFromStore and
- // CertFindCertificateInStore(CERT_FIND_SUBJECT_CERT) APIs see this
- // special KEYID Issuer and SerialNumber, they do a KEYID match.
- //--------------------------------------------------------------------------
- typedef PCCERT_CONTEXT (WINAPI *PFN_CRYPT_GET_SIGNER_CERTIFICATE)(
- IN void *pvGetArg,
- IN DWORD dwCertEncodingType,
- IN PCERT_INFO pSignerId, // Only the Issuer and SerialNumber
- // fields have been updated
- IN HCERTSTORE hMsgCertStore
- );
- //+-------------------------------------------------------------------------
- // The CRYPT_SIGN_MESSAGE_PARA are used for signing messages using the
- // specified signing certificate context.
- //
- // Either the CERT_KEY_PROV_HANDLE_PROP_ID or CERT_KEY_PROV_INFO_PROP_ID must
- // be set for each rgpSigningCert[]. Either one specifies the private
- // signature key to use.
- //
- // If any certificates and/or CRLs are to be included in the signed message,
- // then, the MsgCert and MsgCrl parameters need to be updated. If the
- // rgpSigningCerts are to be included, then, they must also be in the
- // rgpMsgCert array.
- //
- // cbSize must be set to the sizeof(CRYPT_SIGN_MESSAGE_PARA) or else
- // LastError will be updated with E_INVALIDARG.
- //
- // pvHashAuxInfo currently isn't used and must be set to NULL.
- //
- // dwFlags normally is set to 0. However, if the encoded output
- // is to be a CMSG_SIGNED inner content of an outer cryptographic message,
- // such as a CMSG_ENVELOPED, then, the CRYPT_MESSAGE_BARE_CONTENT_OUT_FLAG
- // should be set. If not set, then it would be encoded as an inner content
- // type of CMSG_DATA.
- //
- // dwInnerContentType is normally set to 0. It needs to be set if the
- // ToBeSigned input is the encoded output of another cryptographic
- // message, such as, an CMSG_ENVELOPED. When set, it's one of the cryptographic
- // message types, for example, CMSG_ENVELOPED.
- //
- // If the inner content of a nested cryptographic message is data (CMSG_DATA
- // the default), then, neither dwFlags or dwInnerContentType need to be set.
- //
- // For CMS messages, CRYPT_MESSAGE_ENCAPSULATED_CONTENT_OUT_FLAG may be
- // set to encapsulate nonData inner content within an OCTET STRING.
- //
- // For CMS messages, CRYPT_MESSAGE_KEYID_SIGNER_FLAG may be set to identify
- // signers by their Key Identifier and not their Issuer and Serial Number.
- //
- // The CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be set to suppress any UI by the
- // CSP. See CryptAcquireContext's CRYPT_SILENT flag for more details.
- //
- // If HashEncryptionAlgorithm is present and not NULL its used instead of
- // the SigningCert's PublicKeyInfo.Algorithm.
- //
- // Note, for RSA, the hash encryption algorithm is normally the same as
- // the public key algorithm. For DSA, the hash encryption algorithm is
- // normally a DSS signature algorithm.
- //
- // pvHashEncryptionAuxInfo currently isn't used and must be set to NULL if
- // present in the data structure.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_SIGN_MESSAGE_PARA {
- DWORD cbSize;
- DWORD dwMsgEncodingType;
- PCCERT_CONTEXT pSigningCert;
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- void *pvHashAuxInfo;
- DWORD cMsgCert;
- PCCERT_CONTEXT *rgpMsgCert;
- DWORD cMsgCrl;
- PCCRL_CONTEXT *rgpMsgCrl;
- DWORD cAuthAttr;
- PCRYPT_ATTRIBUTE rgAuthAttr;
- DWORD cUnauthAttr;
- PCRYPT_ATTRIBUTE rgUnauthAttr;
- DWORD dwFlags;
- DWORD dwInnerContentType;
- #ifdef CRYPT_SIGN_MESSAGE_PARA_HAS_CMS_FIELDS
- CRYPT_ALGORITHM_IDENTIFIER HashEncryptionAlgorithm;
- void *pvHashEncryptionAuxInfo;
- #endif
- } CRYPT_SIGN_MESSAGE_PARA, *PCRYPT_SIGN_MESSAGE_PARA;
- #define CRYPT_MESSAGE_BARE_CONTENT_OUT_FLAG 0x00000001
- // When set, nonData type inner content is encapsulated within an
- // OCTET STRING
- #define CRYPT_MESSAGE_ENCAPSULATED_CONTENT_OUT_FLAG 0x00000002
- // When set, signers are identified by their Key Identifier and not
- // their Issuer and Serial Number.
- #define CRYPT_MESSAGE_KEYID_SIGNER_FLAG 0x00000004
- // When set, suppresses any UI by the CSP.
- // See CryptAcquireContext's CRYPT_SILENT flag for more details.
- #define CRYPT_MESSAGE_SILENT_KEYSET_FLAG 0x00000040
- //+-------------------------------------------------------------------------
- // The CRYPT_VERIFY_MESSAGE_PARA are used to verify signed messages.
- //
- // hCryptProv is used to do hashing and signature verification.
- //
- // The dwCertEncodingType specifies the encoding type of the certificates
- // and/or CRLs in the message.
- //
- // pfnGetSignerCertificate is called to get and verify the message signer's
- // certificate.
- //
- // cbSize must be set to the sizeof(CRYPT_VERIFY_MESSAGE_PARA) or else
- // LastError will be updated with E_INVALIDARG.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_VERIFY_MESSAGE_PARA {
- DWORD cbSize;
- DWORD dwMsgAndCertEncodingType;
- HCRYPTPROV hCryptProv;
- PFN_CRYPT_GET_SIGNER_CERTIFICATE pfnGetSignerCertificate;
- void *pvGetArg;
- } CRYPT_VERIFY_MESSAGE_PARA, *PCRYPT_VERIFY_MESSAGE_PARA;
- //+-------------------------------------------------------------------------
- // The CRYPT_ENCRYPT_MESSAGE_PARA are used for encrypting messages.
- //
- // hCryptProv is used to do content encryption, recipient key
- // encryption, and recipient key export. Its private key
- // isn't used.
- //
- // Currently, pvEncryptionAuxInfo is only defined for RC2 or RC4 encryption
- // algorithms. Otherwise, its not used and must be set to NULL.
- // See CMSG_RC2_AUX_INFO for the RC2 encryption algorithms.
- // See CMSG_RC4_AUX_INFO for the RC4 encryption algorithms.
- //
- // To enable SP3 compatible encryption, pvEncryptionAuxInfo should point to
- // a CMSG_SP3_COMPATIBLE_AUX_INFO data structure.
- //
- // cbSize must be set to the sizeof(CRYPT_ENCRYPT_MESSAGE_PARA) or else
- // LastError will be updated with E_INVALIDARG.
- //
- // dwFlags normally is set to 0. However, if the encoded output
- // is to be a CMSG_ENVELOPED inner content of an outer cryptographic message,
- // such as a CMSG_SIGNED, then, the CRYPT_MESSAGE_BARE_CONTENT_OUT_FLAG
- // should be set. If not set, then it would be encoded as an inner content
- // type of CMSG_DATA.
- //
- // dwInnerContentType is normally set to 0. It needs to be set if the
- // ToBeEncrypted input is the encoded output of another cryptographic
- // message, such as, an CMSG_SIGNED. When set, it's one of the cryptographic
- // message types, for example, CMSG_SIGNED.
- //
- // If the inner content of a nested cryptographic message is data (CMSG_DATA
- // the default), then, neither dwFlags or dwInnerContentType need to be set.
- //
- // For CMS messages, CRYPT_MESSAGE_ENCAPSULATED_CONTENT_OUT_FLAG may be
- // set to encapsulate nonData inner content within an OCTET STRING before
- // encrypting.
- //
- // For CMS messages, CRYPT_MESSAGE_KEYID_RECIPIENT_FLAG may be set to identify
- // recipients by their Key Identifier and not their Issuer and Serial Number.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_ENCRYPT_MESSAGE_PARA {
- DWORD cbSize;
- DWORD dwMsgEncodingType;
- HCRYPTPROV hCryptProv;
- CRYPT_ALGORITHM_IDENTIFIER ContentEncryptionAlgorithm;
- void *pvEncryptionAuxInfo;
- DWORD dwFlags;
- DWORD dwInnerContentType;
- } CRYPT_ENCRYPT_MESSAGE_PARA, *PCRYPT_ENCRYPT_MESSAGE_PARA;
- // When set, recipients are identified by their Key Identifier and not
- // their Issuer and Serial Number.
- #define CRYPT_MESSAGE_KEYID_RECIPIENT_FLAG 0x4
- //+-------------------------------------------------------------------------
- // The CRYPT_DECRYPT_MESSAGE_PARA are used for decrypting messages.
- //
- // The CertContext to use for decrypting a message is obtained from one
- // of the specified cert stores. An encrypted message can have one or
- // more recipients. The recipients are identified by their CertId (Issuer
- // and SerialNumber). The cert stores are searched to find the CertContext
- // corresponding to the CertId.
- //
- // For CMS, the recipients may also be identified by their KeyId.
- // CMS also allows Key Agreement (Diffie Hellman) in addition to
- // Key Transport (RSA) recipients.
- //
- // Only CertContexts in the store with either
- // the CERT_KEY_PROV_HANDLE_PROP_ID or CERT_KEY_PROV_INFO_PROP_ID set
- // can be used. Either property specifies the private exchange key to use.
- //
- // cbSize must be set to the sizeof(CRYPT_DECRYPT_MESSAGE_PARA) or else
- // LastError will be updated with E_INVALIDARG.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_DECRYPT_MESSAGE_PARA {
- DWORD cbSize;
- DWORD dwMsgAndCertEncodingType;
- DWORD cCertStore;
- HCERTSTORE *rghCertStore;
- #ifdef CRYPT_DECRYPT_MESSAGE_PARA_HAS_EXTRA_FIELDS
- // The above defined, CRYPT_MESSAGE_SILENT_KEYSET_FLAG, can be set to
- // suppress UI by the CSP. See CryptAcquireContext's CRYPT_SILENT
- // flag for more details.
- DWORD dwFlags;
- #endif
- } CRYPT_DECRYPT_MESSAGE_PARA, *PCRYPT_DECRYPT_MESSAGE_PARA;
- //+-------------------------------------------------------------------------
- // The CRYPT_HASH_MESSAGE_PARA are used for hashing or unhashing
- // messages.
- //
- // hCryptProv is used to compute the hash.
- //
- // pvHashAuxInfo currently isn't used and must be set to NULL.
- //
- // cbSize must be set to the sizeof(CRYPT_HASH_MESSAGE_PARA) or else
- // LastError will be updated with E_INVALIDARG.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_HASH_MESSAGE_PARA {
- DWORD cbSize;
- DWORD dwMsgEncodingType;
- HCRYPTPROV hCryptProv;
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- void *pvHashAuxInfo;
- } CRYPT_HASH_MESSAGE_PARA, *PCRYPT_HASH_MESSAGE_PARA;
- //+-------------------------------------------------------------------------
- // The CRYPT_KEY_SIGN_MESSAGE_PARA are used for signing messages until a
- // certificate has been created for the signature key.
- //
- // pvHashAuxInfo currently isn't used and must be set to NULL.
- //
- // If PubKeyAlgorithm isn't set, defaults to szOID_RSA_RSA.
- //
- // cbSize must be set to the sizeof(CRYPT_KEY_SIGN_MESSAGE_PARA) or else
- // LastError will be updated with E_INVALIDARG.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_KEY_SIGN_MESSAGE_PARA {
- DWORD cbSize;
- DWORD dwMsgAndCertEncodingType;
- HCRYPTPROV hCryptProv;
- DWORD dwKeySpec;
- CRYPT_ALGORITHM_IDENTIFIER HashAlgorithm;
- void *pvHashAuxInfo;
- CRYPT_ALGORITHM_IDENTIFIER PubKeyAlgorithm;
- } CRYPT_KEY_SIGN_MESSAGE_PARA, *PCRYPT_KEY_SIGN_MESSAGE_PARA;
- //+-------------------------------------------------------------------------
- // The CRYPT_KEY_VERIFY_MESSAGE_PARA are used to verify signed messages without
- // a certificate for the signer.
- //
- // Normally used until a certificate has been created for the key.
- //
- // hCryptProv is used to do hashing and signature verification.
- //
- // cbSize must be set to the sizeof(CRYPT_KEY_VERIFY_MESSAGE_PARA) or else
- // LastError will be updated with E_INVALIDARG.
- //--------------------------------------------------------------------------
- typedef struct _CRYPT_KEY_VERIFY_MESSAGE_PARA {
- DWORD cbSize;
- DWORD dwMsgEncodingType;
- HCRYPTPROV hCryptProv;
- } CRYPT_KEY_VERIFY_MESSAGE_PARA, *PCRYPT_KEY_VERIFY_MESSAGE_PARA;
- //+-------------------------------------------------------------------------
- // Sign the message.
- //
- // If fDetachedSignature is TRUE, the "to be signed" content isn't included
- // in the encoded signed blob.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSignMessage(
- IN PCRYPT_SIGN_MESSAGE_PARA pSignPara,
- IN BOOL fDetachedSignature,
- IN DWORD cToBeSigned,
- IN const BYTE *rgpbToBeSigned[],
- IN DWORD rgcbToBeSigned[],
- OUT BYTE *pbSignedBlob,
- IN OUT DWORD *pcbSignedBlob
- );
- //+-------------------------------------------------------------------------
- // Verify a signed message.
- //
- // If pbDecoded == NULL, then, *pcbDecoded is implicitly set to 0 on input.
- // For *pcbDecoded == 0 && ppSignerCert == NULL on input, the signer isn't
- // verified.
- //
- // A message might have more than one signer. Set dwSignerIndex to iterate
- // through all the signers. dwSignerIndex == 0 selects the first signer.
- //
- // pVerifyPara's pfnGetSignerCertificate is called to get the signer's
- // certificate.
- //
- // For a verified signer and message, *ppSignerCert is updated
- // with the CertContext of the signer. It must be freed by calling
- // CertFreeCertificateContext. Otherwise, *ppSignerCert is set to NULL.
- //
- // ppSignerCert can be NULL, indicating the caller isn't interested
- // in getting the CertContext of the signer.
- //
- // pcbDecoded can be NULL, indicating the caller isn't interested in getting
- // the decoded content. Furthermore, if the message doesn't contain any
- // content or signers, then, pcbDecoded must be set to NULL, to allow the
- // pVerifyPara->pfnGetCertificate to be called. Normally, this would be
- // the case when the signed message contains only certficates and CRLs.
- // If pcbDecoded is NULL and the message doesn't have the indicated signer,
- // pfnGetCertificate is called with pSignerId set to NULL.
- //
- // If the message doesn't contain any signers || dwSignerIndex > message's
- // SignerCount, then, an error is returned with LastError set to
- // CRYPT_E_NO_SIGNER. Also, for CRYPT_E_NO_SIGNER, pfnGetSignerCertificate
- // is still called with pSignerId set to NULL.
- //
- // Note, an alternative way to get the certificates and CRLs from a
- // signed message is to call CryptGetMessageCertificates.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptVerifyMessageSignature(
- IN PCRYPT_VERIFY_MESSAGE_PARA pVerifyPara,
- IN DWORD dwSignerIndex,
- IN const BYTE *pbSignedBlob,
- IN DWORD cbSignedBlob,
- OUT BYTE OPTIONAL *pbDecoded,
- IN OUT OPTIONAL DWORD *pcbDecoded,
- OUT OPTIONAL PCCERT_CONTEXT *ppSignerCert
- );
- //+-------------------------------------------------------------------------
- // Returns the count of signers in the signed message. For no signers, returns
- // 0. For an error returns -1 with LastError updated accordingly.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- LONG
- WINAPI
- CryptGetMessageSignerCount(
- IN DWORD dwMsgEncodingType,
- IN const BYTE *pbSignedBlob,
- IN DWORD cbSignedBlob
- );
- //+-------------------------------------------------------------------------
- // Returns the cert store containing the message's certs and CRLs.
- // For an error, returns NULL with LastError updated.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCERTSTORE
- WINAPI
- CryptGetMessageCertificates(
- IN DWORD dwMsgAndCertEncodingType,
- IN HCRYPTPROV hCryptProv, // passed to CertOpenStore
- IN DWORD dwFlags, // passed to CertOpenStore
- IN const BYTE *pbSignedBlob,
- IN DWORD cbSignedBlob
- );
- //+-------------------------------------------------------------------------
- // Verify a signed message containing detached signature(s).
- // The "to be signed" content is passed in separately. No
- // decoded output. Otherwise, identical to CryptVerifyMessageSignature.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptVerifyDetachedMessageSignature(
- IN PCRYPT_VERIFY_MESSAGE_PARA pVerifyPara,
- IN DWORD dwSignerIndex,
- IN const BYTE *pbDetachedSignBlob,
- IN DWORD cbDetachedSignBlob,
- IN DWORD cToBeSigned,
- IN const BYTE *rgpbToBeSigned[],
- IN DWORD rgcbToBeSigned[],
- OUT OPTIONAL PCCERT_CONTEXT *ppSignerCert
- );
- //+-------------------------------------------------------------------------
- // Encrypts the message for the recipient(s).
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptEncryptMessage(
- IN PCRYPT_ENCRYPT_MESSAGE_PARA pEncryptPara,
- IN DWORD cRecipientCert,
- IN PCCERT_CONTEXT rgpRecipientCert[],
- IN const BYTE *pbToBeEncrypted,
- IN DWORD cbToBeEncrypted,
- OUT BYTE *pbEncryptedBlob,
- IN OUT DWORD *pcbEncryptedBlob
- );
- //+-------------------------------------------------------------------------
- // Decrypts the message.
- //
- // If pbDecrypted == NULL, then, *pcbDecrypted is implicitly set to 0 on input.
- // For *pcbDecrypted == 0 && ppXchgCert == NULL on input, the message isn't
- // decrypted.
- //
- // For a successfully decrypted message, *ppXchgCert is updated
- // with the CertContext used to decrypt. It must be freed by calling
- // CertStoreFreeCert. Otherwise, *ppXchgCert is set to NULL.
- //
- // ppXchgCert can be NULL, indicating the caller isn't interested
- // in getting the CertContext used to decrypt.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptDecryptMessage(
- IN PCRYPT_DECRYPT_MESSAGE_PARA pDecryptPara,
- IN const BYTE *pbEncryptedBlob,
- IN DWORD cbEncryptedBlob,
- OUT OPTIONAL BYTE *pbDecrypted,
- IN OUT OPTIONAL DWORD *pcbDecrypted,
- OUT OPTIONAL PCCERT_CONTEXT *ppXchgCert
- );
- //+-------------------------------------------------------------------------
- // Sign the message and encrypt for the recipient(s). Does a CryptSignMessage
- // followed with a CryptEncryptMessage.
- //
- // Note: this isn't the CMSG_SIGNED_AND_ENVELOPED. Its a CMSG_SIGNED
- // inside of an CMSG_ENVELOPED.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSignAndEncryptMessage(
- IN PCRYPT_SIGN_MESSAGE_PARA pSignPara,
- IN PCRYPT_ENCRYPT_MESSAGE_PARA pEncryptPara,
- IN DWORD cRecipientCert,
- IN PCCERT_CONTEXT rgpRecipientCert[],
- IN const BYTE *pbToBeSignedAndEncrypted,
- IN DWORD cbToBeSignedAndEncrypted,
- OUT BYTE *pbSignedAndEncryptedBlob,
- IN OUT DWORD *pcbSignedAndEncryptedBlob
- );
- //+-------------------------------------------------------------------------
- // Decrypts the message and verifies the signer. Does a CryptDecryptMessage
- // followed with a CryptVerifyMessageSignature.
- //
- // If pbDecrypted == NULL, then, *pcbDecrypted is implicitly set to 0 on input.
- // For *pcbDecrypted == 0 && ppSignerCert == NULL on input, the signer isn't
- // verified.
- //
- // A message might have more than one signer. Set dwSignerIndex to iterate
- // through all the signers. dwSignerIndex == 0 selects the first signer.
- //
- // The pVerifyPara's VerifySignerPolicy is called to verify the signer's
- // certificate.
- //
- // For a successfully decrypted and verified message, *ppXchgCert and
- // *ppSignerCert are updated. They must be freed by calling
- // CertStoreFreeCert. Otherwise, they are set to NULL.
- //
- // ppXchgCert and/or ppSignerCert can be NULL, indicating the
- // caller isn't interested in getting the CertContext.
- //
- // Note: this isn't the CMSG_SIGNED_AND_ENVELOPED. Its a CMSG_SIGNED
- // inside of an CMSG_ENVELOPED.
- //
- // The message always needs to be decrypted to allow access to the
- // signed message. Therefore, if ppXchgCert != NULL, its always updated.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptDecryptAndVerifyMessageSignature(
- IN PCRYPT_DECRYPT_MESSAGE_PARA pDecryptPara,
- IN PCRYPT_VERIFY_MESSAGE_PARA pVerifyPara,
- IN DWORD dwSignerIndex,
- IN const BYTE *pbEncryptedBlob,
- IN DWORD cbEncryptedBlob,
- OUT OPTIONAL BYTE *pbDecrypted,
- IN OUT OPTIONAL DWORD *pcbDecrypted,
- OUT OPTIONAL PCCERT_CONTEXT *ppXchgCert,
- OUT OPTIONAL PCCERT_CONTEXT *ppSignerCert
- );
- //+-------------------------------------------------------------------------
- // Decodes a cryptographic message which may be one of the following types:
- // CMSG_DATA
- // CMSG_SIGNED
- // CMSG_ENVELOPED
- // CMSG_SIGNED_AND_ENVELOPED
- // CMSG_HASHED
- //
- // dwMsgTypeFlags specifies the set of allowable messages. For example, to
- // decode either SIGNED or ENVELOPED messages, set dwMsgTypeFlags to:
- // CMSG_SIGNED_FLAG | CMSG_ENVELOPED_FLAG.
- //
- // dwProvInnerContentType is only applicable when processing nested
- // crytographic messages. When processing an outer crytographic message
- // it must be set to 0. When decoding a nested cryptographic message
- // its the dwInnerContentType returned by a previous CryptDecodeMessage
- // of the outer message. The InnerContentType can be any of the CMSG types,
- // for example, CMSG_DATA, CMSG_SIGNED, ...
- //
- // The optional *pdwMsgType is updated with the type of message.
- //
- // The optional *pdwInnerContentType is updated with the type of the inner
- // message. Unless there is cryptographic message nesting, CMSG_DATA
- // is returned.
- //
- // For CMSG_DATA: returns decoded content.
- // For CMSG_SIGNED: same as CryptVerifyMessageSignature.
- // For CMSG_ENVELOPED: same as CryptDecryptMessage.
- // For CMSG_SIGNED_AND_ENVELOPED: same as CryptDecryptMessage plus
- // CryptVerifyMessageSignature.
- // For CMSG_HASHED: verifies the hash and returns decoded content.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptDecodeMessage(
- IN DWORD dwMsgTypeFlags,
- IN PCRYPT_DECRYPT_MESSAGE_PARA pDecryptPara,
- IN PCRYPT_VERIFY_MESSAGE_PARA pVerifyPara,
- IN DWORD dwSignerIndex,
- IN const BYTE *pbEncodedBlob,
- IN DWORD cbEncodedBlob,
- IN DWORD dwPrevInnerContentType,
- OUT OPTIONAL DWORD *pdwMsgType,
- OUT OPTIONAL DWORD *pdwInnerContentType,
- OUT OPTIONAL BYTE *pbDecoded,
- IN OUT OPTIONAL DWORD *pcbDecoded,
- OUT OPTIONAL PCCERT_CONTEXT *ppXchgCert,
- OUT OPTIONAL PCCERT_CONTEXT *ppSignerCert
- );
- //+-------------------------------------------------------------------------
- // Hash the message.
- //
- // If fDetachedHash is TRUE, only the ComputedHash is encoded in the
- // pbHashedBlob. Otherwise, both the ToBeHashed and ComputedHash
- // are encoded.
- //
- // pcbHashedBlob or pcbComputedHash can be NULL, indicating the caller
- // isn't interested in getting the output.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptHashMessage(
- IN PCRYPT_HASH_MESSAGE_PARA pHashPara,
- IN BOOL fDetachedHash,
- IN DWORD cToBeHashed,
- IN const BYTE *rgpbToBeHashed[],
- IN DWORD rgcbToBeHashed[],
- OUT OPTIONAL BYTE *pbHashedBlob,
- IN OUT OPTIONAL DWORD *pcbHashedBlob,
- OUT OPTIONAL BYTE *pbComputedHash,
- IN OUT OPTIONAL DWORD *pcbComputedHash
- );
- //+-------------------------------------------------------------------------
- // Verify a hashed message.
- //
- // pcbToBeHashed or pcbComputedHash can be NULL,
- // indicating the caller isn't interested in getting the output.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptVerifyMessageHash(
- IN PCRYPT_HASH_MESSAGE_PARA pHashPara,
- IN BYTE *pbHashedBlob,
- IN DWORD cbHashedBlob,
- OUT OPTIONAL BYTE *pbToBeHashed,
- IN OUT OPTIONAL DWORD *pcbToBeHashed,
- OUT OPTIONAL BYTE *pbComputedHash,
- IN OUT OPTIONAL DWORD *pcbComputedHash
- );
- //+-------------------------------------------------------------------------
- // Verify a hashed message containing a detached hash.
- // The "to be hashed" content is passed in separately. No
- // decoded output. Otherwise, identical to CryptVerifyMessageHash.
- //
- // pcbComputedHash can be NULL, indicating the caller isn't interested
- // in getting the output.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptVerifyDetachedMessageHash(
- IN PCRYPT_HASH_MESSAGE_PARA pHashPara,
- IN BYTE *pbDetachedHashBlob,
- IN DWORD cbDetachedHashBlob,
- IN DWORD cToBeHashed,
- IN const BYTE *rgpbToBeHashed[],
- IN DWORD rgcbToBeHashed[],
- OUT OPTIONAL BYTE *pbComputedHash,
- IN OUT OPTIONAL DWORD *pcbComputedHash
- );
- //+-------------------------------------------------------------------------
- // Sign the message using the provider's private key specified in the
- // parameters. A dummy SignerId is created and stored in the message.
- //
- // Normally used until a certificate has been created for the key.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSignMessageWithKey(
- IN PCRYPT_KEY_SIGN_MESSAGE_PARA pSignPara,
- IN const BYTE *pbToBeSigned,
- IN DWORD cbToBeSigned,
- OUT BYTE *pbSignedBlob,
- IN OUT DWORD *pcbSignedBlob
- );
- //+-------------------------------------------------------------------------
- // Verify a signed message using the specified public key info.
- //
- // Normally called by a CA until it has created a certificate for the
- // key.
- //
- // pPublicKeyInfo contains the public key to use to verify the signed
- // message. If NULL, the signature isn't verified (for instance, the decoded
- // content may contain the PublicKeyInfo).
- //
- // pcbDecoded can be NULL, indicating the caller isn't interested
- // in getting the decoded content.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptVerifyMessageSignatureWithKey(
- IN PCRYPT_KEY_VERIFY_MESSAGE_PARA pVerifyPara,
- IN OPTIONAL PCERT_PUBLIC_KEY_INFO pPublicKeyInfo,
- IN const BYTE *pbSignedBlob,
- IN DWORD cbSignedBlob,
- OUT OPTIONAL BYTE *pbDecoded,
- IN OUT OPTIONAL DWORD *pcbDecoded
- );
- //+=========================================================================
- // System Certificate Store Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Get a system certificate store based on a subsystem protocol.
- //
- // Current examples of subsystems protocols are:
- // "MY" Cert Store hold certs with associated Private Keys
- // "CA" Certifying Authority certs
- // "ROOT" Root Certs
- // "SPC" Software publisher certs
- //
- //
- // If hProv is NULL the default provider "1" is opened for you.
- // When the store is closed the provider is release. Otherwise
- // if hProv is not NULL, no provider is created or released.
- //
- // The returned Cert Store can be searched for an appropriate Cert
- // using the Cert Store API's (see certstor.h)
- //
- // When done, the cert store should be closed using CertStoreClose
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCERTSTORE
- WINAPI
- CertOpenSystemStoreA(
- HCRYPTPROV hProv,
- LPCSTR szSubsystemProtocol
- );
- WINCRYPT32API
- HCERTSTORE
- WINAPI
- CertOpenSystemStoreW(
- HCRYPTPROV hProv,
- LPCWSTR szSubsystemProtocol
- );
- #ifdef UNICODE
- #define CertOpenSystemStore CertOpenSystemStoreW
- #else
- #define CertOpenSystemStore CertOpenSystemStoreA
- #endif // !UNICODE
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddEncodedCertificateToSystemStoreA(
- LPCSTR szCertStoreName,
- const BYTE * pbCertEncoded,
- DWORD cbCertEncoded
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CertAddEncodedCertificateToSystemStoreW(
- LPCWSTR szCertStoreName,
- const BYTE * pbCertEncoded,
- DWORD cbCertEncoded
- );
- #ifdef UNICODE
- #define CertAddEncodedCertificateToSystemStore CertAddEncodedCertificateToSystemStoreW
- #else
- #define CertAddEncodedCertificateToSystemStore CertAddEncodedCertificateToSystemStoreA
- #endif // !UNICODE
- //+-------------------------------------------------------------------------
- // Find all certificate chains tying the given issuer name to any certificate
- // that the current user has a private key for.
- //
- // If no certificate chain is found, FALSE is returned with LastError set
- // to CRYPT_E_NOT_FOUND and the counts zeroed.
- //
- // IE 3.0 ASSUMPTION:
- // The client certificates are in the "My" system store. The issuer
- // cerificates may be in the "Root", "CA" or "My" system stores.
- //--------------------------------------------------------------------------
- typedef struct _CERT_CHAIN {
- DWORD cCerts; // number of certs in chain
- PCERT_BLOB certs; // pointer to array of cert chain blobs
- // representing the certs
- CRYPT_KEY_PROV_INFO keyLocatorInfo; // key locator for cert
- } CERT_CHAIN, *PCERT_CHAIN;
- // WINCRYPT32API This is not exported by crypt32, it is exported by softpub
- HRESULT
- WINAPI
- FindCertsByIssuer(
- OUT PCERT_CHAIN pCertChains,
- IN OUT DWORD *pcbCertChains,
- OUT DWORD *pcCertChains, // count of certificates chains returned
- IN BYTE* pbEncodedIssuerName, // DER encoded issuer name
- IN DWORD cbEncodedIssuerName, // count in bytes of encoded issuer name
- IN LPCWSTR pwszPurpose, // "ClientAuth" or "CodeSigning"
- IN DWORD dwKeySpec // only return signers supporting this
- // keyspec
- );
- //-------------------------------------------------------------------------
- //
- // CryptQueryObject takes a CERT_BLOB or a file name and returns the
- // information about the content in the blob or in the file.
- //
- // Parameters:
- // INPUT dwObjectType:
- // Indicate the type of the object. Should be one of the
- // following:
- // CERT_QUERY_OBJECT_FILE
- // CERT_QUERY_OBJECT_BLOB
- //
- // INPUT pvObject:
- // If dwObjectType == CERT_QUERY_OBJECT_FILE, it is a
- // LPWSTR, that is, the pointer to a wchar file name
- // if dwObjectType == CERT_QUERY_OBJECT_BLOB, it is a
- // PCERT_BLOB, that is, a pointer to a CERT_BLOB
- //
- // INPUT dwExpectedContentTypeFlags:
- // Indicate the expected contenet type.
- // Can be one of the following:
- // CERT_QUERY_CONTENT_FLAG_ALL (the content can be any type)
- // CERT_QUERY_CONTENT_FLAG_CERT
- // CERT_QUERY_CONTENT_FLAG_CTL
- // CERT_QUERY_CONTENT_FLAG_CRL
- // CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE
- // CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT
- // CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL
- // CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL
- // CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED
- // CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED
- // CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED
- // CERT_QUERY_CONTENT_FLAG_PKCS10
- // CERT_QUERY_CONTENT_FLAG_PFX
- // CERT_QUERY_CONTENT_FLAG_CERT_PAIR
- //
- // INPUT dwExpectedFormatTypeFlags:
- // Indicate the expected format type.
- // Can be one of the following:
- // CERT_QUERY_FORMAT_FLAG_ALL (the content can be any format)
- // CERT_QUERY_FORMAT_FLAG_BINARY
- // CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED
- // CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED
- //
- //
- // INPUT dwFlags
- // Reserved flag. Should always set to 0
- //
- // OUTPUT pdwMsgAndCertEncodingType
- // Optional output. If NULL != pdwMsgAndCertEncodingType,
- // it contains the encoding type of the content as any
- // combination of the following:
- // X509_ASN_ENCODING
- // PKCS_7_ASN_ENCODING
- //
- // OUTPUT pdwContentType
- // Optional output. If NULL!=pdwContentType, it contains
- // the content type as one of the the following:
- // CERT_QUERY_CONTENT_CERT
- // CERT_QUERY_CONTENT_CTL
- // CERT_QUERY_CONTENT_CRL
- // CERT_QUERY_CONTENT_SERIALIZED_STORE
- // CERT_QUERY_CONTENT_SERIALIZED_CERT
- // CERT_QUERY_CONTENT_SERIALIZED_CTL
- // CERT_QUERY_CONTENT_SERIALIZED_CRL
- // CERT_QUERY_CONTENT_PKCS7_SIGNED
- // CERT_QUERY_CONTENT_PKCS7_UNSIGNED
- // CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED
- // CERT_QUERY_CONTENT_PKCS10
- // CERT_QUERY_CONTENT_PFX
- // CERT_QUERY_CONTENT_CERT_PAIR
- //
- // OUTPUT pdwFormatType
- // Optional output. If NULL !=pdwFormatType, it
- // contains the format type of the content as one of the
- // following:
- // CERT_QUERY_FORMAT_BINARY
- // CERT_QUERY_FORMAT_BASE64_ENCODED
- // CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED
- //
- //
- // OUTPUT phCertStore
- // Optional output. If NULL !=phStore,
- // it contains a cert store that includes all of certificates,
- // CRL, and CTL in the object if the object content type is
- // one of the following:
- // CERT_QUERY_CONTENT_CERT
- // CERT_QUERY_CONTENT_CTL
- // CERT_QUERY_CONTENT_CRL
- // CERT_QUERY_CONTENT_SERIALIZED_STORE
- // CERT_QUERY_CONTENT_SERIALIZED_CERT
- // CERT_QUERY_CONTENT_SERIALIZED_CTL
- // CERT_QUERY_CONTENT_SERIALIZED_CRL
- // CERT_QUERY_CONTENT_PKCS7_SIGNED
- // CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED
- // CERT_QUERY_CONTENT_CERT_PAIR
- //
- // Caller should free *phCertStore via CertCloseStore.
- //
- //
- // OUTPUT phMsg Optional output. If NULL != phMsg,
- // it contains a handle to a opened message if
- // the content type is one of the following:
- // CERT_QUERY_CONTENT_PKCS7_SIGNED
- // CERT_QUERY_CONTENT_PKCS7_UNSIGNED
- // CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED
- //
- // Caller should free *phMsg via CryptMsgClose.
- //
- // OUTPUT pContext Optional output. If NULL != pContext,
- // it contains either a PCCERT_CONTEXT or PCCRL_CONTEXT,
- // or PCCTL_CONTEXT based on the content type.
- //
- // If the content type is CERT_QUERY_CONTENT_CERT or
- // CERT_QUERY_CONTENT_SERIALIZED_CERT, it is a PCCERT_CONTEXT;
- // Caller should free the pContext via CertFreeCertificateContext.
- //
- // If the content type is CERT_QUERY_CONTENT_CRL or
- // CERT_QUERY_CONTENT_SERIALIZED_CRL, it is a PCCRL_CONTEXT;
- // Caller should free the pContext via CertFreeCRLContext.
- //
- // If the content type is CERT_QUERY_CONTENT_CTL or
- // CERT_QUERY_CONTENT_SERIALIZED_CTL, it is a PCCTL_CONTEXT;
- // Caller should free the pContext via CertFreeCTLContext.
- //
- // If the *pbObject is of type CERT_QUERY_CONTENT_PKCS10 or CERT_QUERY_CONTENT_PFX, CryptQueryObject
- // will not return anything in *phCertstore, *phMsg, or *ppvContext.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptQueryObject(
- DWORD dwObjectType,
- const void *pvObject,
- DWORD dwExpectedContentTypeFlags,
- DWORD dwExpectedFormatTypeFlags,
- DWORD dwFlags,
- DWORD *pdwMsgAndCertEncodingType,
- DWORD *pdwContentType,
- DWORD *pdwFormatType,
- HCERTSTORE *phCertStore,
- HCRYPTMSG *phMsg,
- const void **ppvContext
- );
- //-------------------------------------------------------------------------
- //dwObjectType for CryptQueryObject
- //-------------------------------------------------------------------------
- #define CERT_QUERY_OBJECT_FILE 0x00000001
- #define CERT_QUERY_OBJECT_BLOB 0x00000002
- //-------------------------------------------------------------------------
- //dwContentType for CryptQueryObject
- //-------------------------------------------------------------------------
- //encoded single certificate
- #define CERT_QUERY_CONTENT_CERT 1
- //encoded single CTL
- #define CERT_QUERY_CONTENT_CTL 2
- //encoded single CRL
- #define CERT_QUERY_CONTENT_CRL 3
- //serialized store
- #define CERT_QUERY_CONTENT_SERIALIZED_STORE 4
- //serialized single certificate
- #define CERT_QUERY_CONTENT_SERIALIZED_CERT 5
- //serialized single CTL
- #define CERT_QUERY_CONTENT_SERIALIZED_CTL 6
- //serialized single CRL
- #define CERT_QUERY_CONTENT_SERIALIZED_CRL 7
- //a PKCS#7 signed message
- #define CERT_QUERY_CONTENT_PKCS7_SIGNED 8
- //a PKCS#7 message, such as enveloped message. But it is not a signed message,
- #define CERT_QUERY_CONTENT_PKCS7_UNSIGNED 9
- //a PKCS7 signed message embedded in a file
- #define CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED 10
- //an encoded PKCS#10
- #define CERT_QUERY_CONTENT_PKCS10 11
- //an encoded PKX BLOB
- #define CERT_QUERY_CONTENT_PFX 12
- //an encoded CertificatePair (contains forward and/or reverse cross certs)
- #define CERT_QUERY_CONTENT_CERT_PAIR 13
- //-------------------------------------------------------------------------
- //dwExpectedConentTypeFlags for CryptQueryObject
- //-------------------------------------------------------------------------
- //encoded single certificate
- #define CERT_QUERY_CONTENT_FLAG_CERT \
- ( 1 << CERT_QUERY_CONTENT_CERT)
- //encoded single CTL
- #define CERT_QUERY_CONTENT_FLAG_CTL \
- ( 1 << CERT_QUERY_CONTENT_CTL)
- //encoded single CRL
- #define CERT_QUERY_CONTENT_FLAG_CRL \
- ( 1 << CERT_QUERY_CONTENT_CRL)
- //serialized store
- #define CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE \
- ( 1 << CERT_QUERY_CONTENT_SERIALIZED_STORE)
- //serialized single certificate
- #define CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT \
- ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CERT)
- //serialized single CTL
- #define CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL \
- ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CTL)
- //serialized single CRL
- #define CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL \
- ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CRL)
- //an encoded PKCS#7 signed message
- #define CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED \
- ( 1 << CERT_QUERY_CONTENT_PKCS7_SIGNED)
- //an encoded PKCS#7 message. But it is not a signed message
- #define CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED \
- ( 1 << CERT_QUERY_CONTENT_PKCS7_UNSIGNED)
- //the content includes an embedded PKCS7 signed message
- #define CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED \
- ( 1 << CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED)
- //an encoded PKCS#10
- #define CERT_QUERY_CONTENT_FLAG_PKCS10 \
- ( 1 << CERT_QUERY_CONTENT_PKCS10)
- //an encoded PFX BLOB
- #define CERT_QUERY_CONTENT_FLAG_PFX \
- ( 1 << CERT_QUERY_CONTENT_PFX)
- //an encoded CertificatePair (contains forward and/or reverse cross certs)
- #define CERT_QUERY_CONTENT_FLAG_CERT_PAIR \
- ( 1 << CERT_QUERY_CONTENT_CERT_PAIR)
- //content can be any type
- #define CERT_QUERY_CONTENT_FLAG_ALL \
- CERT_QUERY_CONTENT_FLAG_CERT | \
- CERT_QUERY_CONTENT_FLAG_CTL | \
- CERT_QUERY_CONTENT_FLAG_CRL | \
- CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE | \
- CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT | \
- CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL | \
- CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL | \
- CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED | \
- CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED | \
- CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED | \
- CERT_QUERY_CONTENT_FLAG_PKCS10 | \
- CERT_QUERY_CONTENT_FLAG_PFX | \
- CERT_QUERY_CONTENT_FLAG_CERT_PAIR
- //-------------------------------------------------------------------------
- //dwFormatType for CryptQueryObject
- //-------------------------------------------------------------------------
- //the content is in binary format
- #define CERT_QUERY_FORMAT_BINARY 1
- //the content is base64 encoded
- #define CERT_QUERY_FORMAT_BASE64_ENCODED 2
- //the content is ascii hex encoded with "{ASN}" prefix
- #define CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED 3
- //-------------------------------------------------------------------------
- //dwExpectedFormatTypeFlags for CryptQueryObject
- //-------------------------------------------------------------------------
- //the content is in binary format
- #define CERT_QUERY_FORMAT_FLAG_BINARY \
- ( 1 << CERT_QUERY_FORMAT_BINARY)
- //the content is base64 encoded
- #define CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED \
- ( 1 << CERT_QUERY_FORMAT_BASE64_ENCODED)
- //the content is ascii hex encoded with "{ASN}" prefix
- #define CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED \
- ( 1 << CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED)
- //the content can be of any format
- #define CERT_QUERY_FORMAT_FLAG_ALL \
- CERT_QUERY_FORMAT_FLAG_BINARY | \
- CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED | \
- CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED
- //
- // Crypt32 Memory Management Routines. All Crypt32 API which return allocated
- // buffers will do so via CryptMemAlloc, CryptMemRealloc. Clients can free
- // those buffers using CryptMemFree. Also included is CryptMemSize
- //
- WINCRYPT32API
- LPVOID
- WINAPI
- CryptMemAlloc (
- IN ULONG cbSize
- );
- WINCRYPT32API
- LPVOID
- WINAPI
- CryptMemRealloc (
- IN LPVOID pv,
- IN ULONG cbSize
- );
- WINCRYPT32API
- VOID
- WINAPI
- CryptMemFree (
- IN LPVOID pv
- );
- //
- // Crypt32 Asynchronous Parameter Management Routines. All Crypt32 API which
- // expose asynchronous mode operation use a Crypt32 Async Handle to pass
- // around information about the operation e.g. callback routines. The
- // following API are used for manipulation of the async handle
- //
- typedef HANDLE HCRYPTASYNC, *PHCRYPTASYNC;
- typedef VOID (WINAPI *PFN_CRYPT_ASYNC_PARAM_FREE_FUNC) (
- LPSTR pszParamOid,
- LPVOID pvParam
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptCreateAsyncHandle (
- IN DWORD dwFlags,
- OUT PHCRYPTASYNC phAsync
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSetAsyncParam (
- IN HCRYPTASYNC hAsync,
- IN LPSTR pszParamOid,
- IN LPVOID pvParam,
- IN OPTIONAL PFN_CRYPT_ASYNC_PARAM_FREE_FUNC pfnFree
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetAsyncParam (
- IN HCRYPTASYNC hAsync,
- IN LPSTR pszParamOid,
- OUT LPVOID* ppvParam,
- OUT OPTIONAL PFN_CRYPT_ASYNC_PARAM_FREE_FUNC* ppfnFree
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptCloseAsyncHandle (
- IN HCRYPTASYNC hAsync
- );
- //
- // Crypt32 Remote Object Retrieval Routines. This API allows retrieval of
- // remote PKI objects where the location is given by an URL. The remote
- // object retrieval manager exposes two provider models. One is the "Scheme
- // Provider" model which allows for installable protocol providers as defined
- // by the URL scheme e.g. ldap, http, ftp. The scheme provider entry point is
- // the same as the CryptRetrieveObjectByUrl however the *ppvObject returned
- // is ALWAYS a counted array of encoded bits (one per object retrieved). The
- // second provider model is the "Context Provider" model which allows for
- // installable creators of CAPI2 context handles (objects) based on the
- // retrieved encoded bits. These are dispatched based on the object OID given
- // in the call to CryptRetrieveObjectByUrl.
- //
- typedef struct _CRYPT_BLOB_ARRAY {
- DWORD cBlob;
- PCRYPT_DATA_BLOB rgBlob;
- } CRYPT_BLOB_ARRAY, *PCRYPT_BLOB_ARRAY;
- typedef struct _CRYPT_CREDENTIALS {
- DWORD cbSize;
- LPCSTR pszCredentialsOid;
- LPVOID pvCredentials;
- } CRYPT_CREDENTIALS, *PCRYPT_CREDENTIALS;
- #define CREDENTIAL_OID_PASSWORD_CREDENTIALS_A ((LPCSTR)1)
- #define CREDENTIAL_OID_PASSWORD_CREDENTIALS_W ((LPCSTR)2)
- #ifdef UNICODE
- #define CREDENTIAL_OID_PASSWORD_CREDENTIALS CREDENTIAL_OID_PASSWORD_CREDENTIALS_W
- #else
- #define CREDENTIAL_OID_PASSWORD_CREDENTIALS CREDENTIAL_OID_PASSWORD_CREDENTIALS_A
- #endif //UNICODE
- typedef struct _CRYPT_PASSWORD_CREDENTIALSA {
- DWORD cbSize;
- LPSTR pszUsername;
- LPSTR pszPassword;
- } CRYPT_PASSWORD_CREDENTIALSA, *PCRYPT_PASSWORD_CREDENTIALSA;
- typedef struct _CRYPT_PASSWORD_CREDENTIALSW {
- DWORD cbSize;
- LPWSTR pszUsername;
- LPWSTR pszPassword;
- } CRYPT_PASSWORD_CREDENTIALSW, *PCRYPT_PASSWORD_CREDENTIALSW;
- #ifdef UNICODE
- typedef CRYPT_PASSWORD_CREDENTIALSW CRYPT_PASSWORD_CREDENTIALS;
- typedef PCRYPT_PASSWORD_CREDENTIALSW PCRYPT_PASSWORD_CREDENTIALS;
- #else
- typedef CRYPT_PASSWORD_CREDENTIALSA CRYPT_PASSWORD_CREDENTIALS;
- typedef PCRYPT_PASSWORD_CREDENTIALSA PCRYPT_PASSWORD_CREDENTIALS;
- #endif // UNICODE
- //
- // Scheme Provider Signatures
- //
- // The following is obsolete and has been replaced with the following
- // definition
- #define SCHEME_OID_RETRIEVE_ENCODED_OBJECT_FUNC "SchemeDllRetrieveEncodedObject"
- // 2-8-02 .NET Server changed to use UNICODE Url strings instead of multibyte
- #define SCHEME_OID_RETRIEVE_ENCODED_OBJECTW_FUNC "SchemeDllRetrieveEncodedObjectW"
- typedef VOID (WINAPI *PFN_FREE_ENCODED_OBJECT_FUNC) (
- LPCSTR pszObjectOid,
- PCRYPT_BLOB_ARRAY pObject,
- LPVOID pvFreeContext
- );
- //
- // SchemeDllRetrieveEncodedObject was replaced in .NET Server with
- // the following. (Changed to use UNICODE Url Strings.)
- //
- //
- // SchemeDllRetrieveEncodedObjectW has the following signature:
- //
- // BOOL WINAPI SchemeDllRetrieveEncodedObjectW (
- // IN LPCWSTR pwszUrl,
- // IN LPCSTR pszObjectOid,
- // IN DWORD dwRetrievalFlags,
- // IN DWORD dwTimeout, // milliseconds
- // OUT PCRYPT_BLOB_ARRAY pObject,
- // OUT PFN_FREE_ENCODED_OBJECT_FUNC* ppfnFreeObject,
- // OUT LPVOID* ppvFreeContext,
- // IN HCRYPTASYNC hAsyncRetrieve,
- // IN PCRYPT_CREDENTIALS pCredentials,
- // IN PCRYPT_RETRIEVE_AUX_INFO pAuxInfo
- // )
- //
- //
- // Context Provider Signatures
- //
- #define CONTEXT_OID_CREATE_OBJECT_CONTEXT_FUNC "ContextDllCreateObjectContext"
- #define CONTEXT_OID_CERTIFICATE ((LPCSTR)1)
- #define CONTEXT_OID_CRL ((LPCSTR)2)
- #define CONTEXT_OID_CTL ((LPCSTR)3)
- #define CONTEXT_OID_PKCS7 ((LPCSTR)4)
- #define CONTEXT_OID_CAPI2_ANY ((LPCSTR)5)
- //
- // ContextDllCreateObjectContext has the following signature:
- //
- // BOOL WINAPI ContextDllCreateObjectContext (
- // IN LPCSTR pszObjectOid,
- // IN DWORD dwRetrievalFlags,
- // IN PCRYPT_BLOB_ARRAY pObject,
- // OUT LPVOID* ppvContext
- // )
- //
- //
- // Remote Object Retrieval API
- //
- //
- // Retrieval flags
- //
- #define CRYPT_RETRIEVE_MULTIPLE_OBJECTS 0x00000001
- #define CRYPT_CACHE_ONLY_RETRIEVAL 0x00000002
- #define CRYPT_WIRE_ONLY_RETRIEVAL 0x00000004
- #define CRYPT_DONT_CACHE_RESULT 0x00000008
- #define CRYPT_ASYNC_RETRIEVAL 0x00000010
- #define CRYPT_STICKY_CACHE_RETRIEVAL 0x00001000
- #define CRYPT_LDAP_SCOPE_BASE_ONLY_RETRIEVAL 0x00002000
- #define CRYPT_OFFLINE_CHECK_RETRIEVAL 0x00004000
- // When the following flag is set, the following 2 NULL terminated ascii
- // strings are inserted at the beginning of each returned blob:
- // "%d\0%s\0", dwEntryIndex, pszAttribute
- //
- // The first dwEntryIndex is 0, "0\0".
- //
- // When set, pszObjectOid must be NULL, so that a PCRYPT_BLOB_ARRAY is returned.
- #define CRYPT_LDAP_INSERT_ENTRY_ATTRIBUTE 0x00008000
- // Set this flag to digitally sign all of the ldap traffic to and from a
- // Windows 2000 LDAP server using the Kerberos authentication protocol.
- // This feature provides integrity required by some applications.
- #define CRYPT_LDAP_SIGN_RETRIEVAL 0x00010000
- // Set this flag to inhibit automatic authentication handling. See the
- // wininet flag, INTERNET_FLAG_NO_AUTH, for more details.
- #define CRYPT_NO_AUTH_RETRIEVAL 0x00020000
- // Performs an A-Record only DNS lookup on the supplied host string.
- // This prevents bogus DNS queries from being generated when resolving host
- // names. Use this flag whenever passing a hostname as opposed to a
- // domain name for the hostname parameter.
- //
- // See LDAP_OPT_AREC_EXCLUSIVE defined in winldap.h for more details.
- #define CRYPT_LDAP_AREC_EXCLUSIVE_RETRIEVAL 0x00040000
- // Apply AIA URL restrictions, such as, validate retrieved content before
- // writing to cache.
- #define CRYPT_AIA_RETRIEVAL 0x00080000
- //
- // Data verification retrieval flags
- //
- // CRYPT_VERIFY_CONTEXT_SIGNATURE is used to get signature verification
- // on the context created. In this case pszObjectOid must be non-NULL and
- // pvVerify points to the signer certificate context
- //
- // CRYPT_VERIFY_DATA_HASH is used to get verification of the blob data
- // retrieved by the protocol. The pvVerify points to an URL_DATA_HASH
- // structure (TBD)
- //
- #define CRYPT_VERIFY_CONTEXT_SIGNATURE 0x00000020
- #define CRYPT_VERIFY_DATA_HASH 0x00000040
- //
- // Time Valid Object flags
- //
- #define CRYPT_KEEP_TIME_VALID 0x00000080
- #define CRYPT_DONT_VERIFY_SIGNATURE 0x00000100
- #define CRYPT_DONT_CHECK_TIME_VALIDITY 0x00000200
- // The default checks if ftNextUpdate >= ftValidFor. Set this flag to
- // check if ftThisUpdate >= ftValidFor.
- #define CRYPT_CHECK_FRESHNESS_TIME_VALIDITY 0x00000400
- #define CRYPT_ACCUMULATIVE_TIMEOUT 0x00000800
- typedef struct _CRYPT_RETRIEVE_AUX_INFO {
- DWORD cbSize;
- FILETIME *pLastSyncTime;
- DWORD dwMaxUrlRetrievalByteCount; // 0 => implies no limit
- } CRYPT_RETRIEVE_AUX_INFO, *PCRYPT_RETRIEVE_AUX_INFO;
- WINCRYPT32API
- BOOL
- WINAPI
- CryptRetrieveObjectByUrlA (
- IN LPCSTR pszUrl,
- IN LPCSTR pszObjectOid,
- IN DWORD dwRetrievalFlags,
- IN DWORD dwTimeout, // milliseconds
- OUT LPVOID* ppvObject,
- IN HCRYPTASYNC hAsyncRetrieve,
- IN OPTIONAL PCRYPT_CREDENTIALS pCredentials,
- IN OPTIONAL LPVOID pvVerify,
- IN OPTIONAL PCRYPT_RETRIEVE_AUX_INFO pAuxInfo
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptRetrieveObjectByUrlW (
- IN LPCWSTR pszUrl,
- IN LPCSTR pszObjectOid,
- IN DWORD dwRetrievalFlags,
- IN DWORD dwTimeout, // milliseconds
- OUT LPVOID* ppvObject,
- IN HCRYPTASYNC hAsyncRetrieve,
- IN OPTIONAL PCRYPT_CREDENTIALS pCredentials,
- IN OPTIONAL LPVOID pvVerify,
- IN OPTIONAL PCRYPT_RETRIEVE_AUX_INFO pAuxInfo
- );
- #ifdef UNICODE
- #define CryptRetrieveObjectByUrl CryptRetrieveObjectByUrlW
- #else
- #define CryptRetrieveObjectByUrl CryptRetrieveObjectByUrlA
- #endif // !UNICODE
- //
- // Call back function to cancel object retrieval
- //
- // The function can be installed on a per thread basis.
- // If CryptInstallCancelRetrieval is called for multiple times, only the most recent
- // installation will be kept.
- //
- // This is only effective for http, https, gopher, and ftp protocol.
- // It is ignored by the rest of the protocols.
- typedef BOOL (WINAPI *PFN_CRYPT_CANCEL_RETRIEVAL)(
- IN DWORD dwFlags,
- IN void *pvArg
- );
- //
- // PFN_CRYPT_CANCEL_RETRIEVAL
- //
- // This function should return FALSE when the object retrieval should be continued
- // and return TRUE when the object retrieval should be cancelled.
- //
- WINCRYPT32API
- BOOL
- WINAPI
- CryptInstallCancelRetrieval(
- IN PFN_CRYPT_CANCEL_RETRIEVAL pfnCancel,
- IN const void *pvArg,
- IN DWORD dwFlags,
- IN void *pvReserved
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptUninstallCancelRetrieval(
- IN DWORD dwFlags,
- IN void *pvReserved
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptCancelAsyncRetrieval (
- HCRYPTASYNC hAsyncRetrieval
- );
- //
- // Remote Object Async Retrieval parameters
- //
- //
- // A client that wants to be notified of asynchronous object retrieval
- // completion sets this parameter on the async handle
- //
- #define CRYPT_PARAM_ASYNC_RETRIEVAL_COMPLETION ((LPCSTR)1)
- typedef VOID (WINAPI *PFN_CRYPT_ASYNC_RETRIEVAL_COMPLETION_FUNC) (
- IN LPVOID pvCompletion,
- IN DWORD dwCompletionCode,
- IN LPCSTR pszUrl,
- IN LPSTR pszObjectOid,
- IN LPVOID pvObject
- );
- typedef struct _CRYPT_ASYNC_RETRIEVAL_COMPLETION {
- PFN_CRYPT_ASYNC_RETRIEVAL_COMPLETION_FUNC pfnCompletion;
- LPVOID pvCompletion;
- } CRYPT_ASYNC_RETRIEVAL_COMPLETION, *PCRYPT_ASYNC_RETRIEVAL_COMPLETION;
- //
- // This function is set on the async handle by a scheme provider that
- // supports asynchronous retrieval
- //
- #define CRYPT_PARAM_CANCEL_ASYNC_RETRIEVAL ((LPCSTR)2)
- typedef BOOL (WINAPI *PFN_CANCEL_ASYNC_RETRIEVAL_FUNC) (
- HCRYPTASYNC hAsyncRetrieve
- );
- //
- // Get the locator for a CAPI object
- //
- #define CRYPT_GET_URL_FROM_PROPERTY 0x00000001
- #define CRYPT_GET_URL_FROM_EXTENSION 0x00000002
- #define CRYPT_GET_URL_FROM_UNAUTH_ATTRIBUTE 0x00000004
- #define CRYPT_GET_URL_FROM_AUTH_ATTRIBUTE 0x00000008
- typedef struct _CRYPT_URL_ARRAY {
- DWORD cUrl;
- LPWSTR* rgwszUrl;
- } CRYPT_URL_ARRAY, *PCRYPT_URL_ARRAY;
- typedef struct _CRYPT_URL_INFO {
- DWORD cbSize;
- // Seconds between syncs
- DWORD dwSyncDeltaTime;
- // Returned URLs may be grouped. For instance, groups of cross cert
- // distribution points. Each distribution point may have multiple
- // URLs, (LDAP and HTTP scheme).
- DWORD cGroup;
- DWORD *rgcGroupEntry;
- } CRYPT_URL_INFO, *PCRYPT_URL_INFO;
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetObjectUrl (
- IN LPCSTR pszUrlOid,
- IN LPVOID pvPara,
- IN DWORD dwFlags,
- OUT OPTIONAL PCRYPT_URL_ARRAY pUrlArray,
- IN OUT DWORD* pcbUrlArray,
- OUT OPTIONAL PCRYPT_URL_INFO pUrlInfo,
- IN OUT OPTIONAL DWORD* pcbUrlInfo,
- IN OPTIONAL LPVOID pvReserved
- );
- #define URL_OID_GET_OBJECT_URL_FUNC "UrlDllGetObjectUrl"
- //
- // UrlDllGetObjectUrl has the same signature as CryptGetObjectUrl
- //
- //
- // URL_OID_CERTIFICATE_ISSUER
- //
- // pvPara == PCCERT_CONTEXT, certificate whose issuer's URL is being requested
- //
- // This will be retrieved from the authority info access extension or property
- // on the certificate
- //
- // URL_OID_CERTIFICATE_CRL_DIST_POINT
- //
- // pvPara == PCCERT_CONTEXT, certificate whose CRL distribution point is being
- // requested
- //
- // This will be retrieved from the CRL distribution point extension or property
- // on the certificate
- //
- // URL_OID_CTL_ISSUER
- //
- // pvPara == PCCTL_CONTEXT, Signer Index, CTL whose issuer's URL (identified
- // by the signer index) is being requested
- //
- // This will be retrieved from an authority info access attribute method encoded
- // in each signer info in the PKCS7 (CTL)
- //
- // URL_OID_CTL_NEXT_UPDATE
- //
- // pvPara == PCCTL_CONTEXT, Signer Index, CTL whose next update URL is being
- // requested and an optional signer index in case we need to check signer
- // info attributes
- //
- // This will be retrieved from an authority info access CTL extension, property,
- // or signer info attribute method
- //
- // URL_OID_CRL_ISSUER
- //
- // pvPara == PCCRL_CONTEXT, CRL whose issuer's URL is being requested
- //
- // This will be retrieved from a property on the CRL which has been inherited
- // from the subject cert (either from the subject cert issuer or the subject
- // cert distribution point extension). It will be encoded as an authority
- // info access extension method.
- //
- // URL_OID_CERTIFICATE_FRESHEST_CRL
- //
- // pvPara == PCCERT_CONTEXT, certificate whose freshest CRL distribution point
- // is being requested
- //
- // This will be retrieved from the freshest CRL extension or property
- // on the certificate
- //
- // URL_OID_CRL_FRESHEST_CRL
- //
- // pvPara == PCCERT_CRL_CONTEXT_PAIR, certificate's base CRL whose
- // freshest CRL distribution point is being requested
- //
- // This will be retrieved from the freshest CRL extension or property
- // on the CRL
- //
- // URL_OID_CROSS_CERT_DIST_POINT
- //
- // pvPara == PCCERT_CONTEXT, certificate whose cross certificate distribution
- // point is being requested
- //
- // This will be retrieved from the cross certificate distribution point
- // extension or property on the certificate
- //
- #define URL_OID_CERTIFICATE_ISSUER ((LPCSTR)1)
- #define URL_OID_CERTIFICATE_CRL_DIST_POINT ((LPCSTR)2)
- #define URL_OID_CTL_ISSUER ((LPCSTR)3)
- #define URL_OID_CTL_NEXT_UPDATE ((LPCSTR)4)
- #define URL_OID_CRL_ISSUER ((LPCSTR)5)
- #define URL_OID_CERTIFICATE_FRESHEST_CRL ((LPCSTR)6)
- #define URL_OID_CRL_FRESHEST_CRL ((LPCSTR)7)
- #define URL_OID_CROSS_CERT_DIST_POINT ((LPCSTR)8)
- typedef struct _CERT_CRL_CONTEXT_PAIR {
- PCCERT_CONTEXT pCertContext;
- PCCRL_CONTEXT pCrlContext;
- } CERT_CRL_CONTEXT_PAIR, *PCERT_CRL_CONTEXT_PAIR;
- typedef const CERT_CRL_CONTEXT_PAIR *PCCERT_CRL_CONTEXT_PAIR;
- //
- // Get a time valid CAPI2 object
- //
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetTimeValidObject (
- IN LPCSTR pszTimeValidOid,
- IN LPVOID pvPara,
- IN PCCERT_CONTEXT pIssuer,
- IN OPTIONAL LPFILETIME pftValidFor,
- IN DWORD dwFlags,
- IN DWORD dwTimeout, // milliseconds
- OUT OPTIONAL LPVOID* ppvObject,
- IN OPTIONAL PCRYPT_CREDENTIALS pCredentials,
- IN OPTIONAL LPVOID pvReserved
- );
- #define TIME_VALID_OID_GET_OBJECT_FUNC "TimeValidDllGetObject"
- //
- // TimeValidDllGetObject has the same signature as CryptGetTimeValidObject
- //
- //
- // TIME_VALID_OID_GET_CTL
- //
- // pvPara == PCCTL_CONTEXT, the current CTL
- //
- // TIME_VALID_OID_GET_CRL
- //
- // pvPara == PCCRL_CONTEXT, the current CRL
- //
- // TIME_VALID_OID_GET_CRL_FROM_CERT
- //
- // pvPara == PCCERT_CONTEXT, the subject cert
- //
- // TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CERT
- //
- // pvPara == PCCERT_CONTEXT, the subject cert
- //
- // TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CRL
- //
- // pvPara == PCCERT_CRL_CONTEXT_PAIR, the subject cert and its base CRL
- //
- #define TIME_VALID_OID_GET_CTL ((LPCSTR)1)
- #define TIME_VALID_OID_GET_CRL ((LPCSTR)2)
- #define TIME_VALID_OID_GET_CRL_FROM_CERT ((LPCSTR)3)
- #define TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CERT ((LPCSTR)4)
- #define TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CRL ((LPCSTR)5)
- WINCRYPT32API
- BOOL
- WINAPI
- CryptFlushTimeValidObject (
- IN LPCSTR pszFlushTimeValidOid,
- IN LPVOID pvPara,
- IN PCCERT_CONTEXT pIssuer,
- IN DWORD dwFlags,
- IN LPVOID pvReserved
- );
- #define TIME_VALID_OID_FLUSH_OBJECT_FUNC "TimeValidDllFlushObject"
- //
- // TimeValidDllFlushObject has the same signature as CryptFlushTimeValidObject
- //
- //
- // TIME_VALID_OID_FLUSH_CTL
- //
- // pvPara == PCCTL_CONTEXT, the CTL to flush
- //
- // TIME_VALID_OID_FLUSH_CRL
- //
- // pvPara == PCCRL_CONTEXT, the CRL to flush
- //
- // TIME_VALID_OID_FLUSH_CRL_FROM_CERT
- //
- // pvPara == PCCERT_CONTEXT, the subject cert's CRL to flush
- //
- // TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CERT
- //
- // pvPara == PCCERT_CONTEXT, the subject cert's freshest CRL to flush
- //
- // TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CRL
- //
- // pvPara == PCCERT_CRL_CONTEXT_PAIR, the subject cert and its base CRL's
- // freshest CRL to flush
- //
- #define TIME_VALID_OID_FLUSH_CTL ((LPCSTR)1)
- #define TIME_VALID_OID_FLUSH_CRL ((LPCSTR)2)
- #define TIME_VALID_OID_FLUSH_CRL_FROM_CERT ((LPCSTR)3)
- #define TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CERT ((LPCSTR)4)
- #define TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CRL ((LPCSTR)5)
- //-------------------------------------------------------------------------
- // Data Protection APIs
- //-------------------------------------------------------------------------
- //
- // Data protection APIs enable applications to easily secure data.
- //
- // The base provider provides protection based on the users' logon
- // credentials. The data secured with these APIs follow the same
- // roaming characteristics as HKCU -- if HKCU roams, the data
- // protected by the base provider may roam as well. This makes
- // the API ideal for the munging of data stored in the registry.
- //
- //
- // Prompt struct -- what to tell users about the access
- //
- typedef struct _CRYPTPROTECT_PROMPTSTRUCT
- {
- DWORD cbSize;
- DWORD dwPromptFlags;
- HWND hwndApp;
- LPCWSTR szPrompt;
- } CRYPTPROTECT_PROMPTSTRUCT, *PCRYPTPROTECT_PROMPTSTRUCT;
- //
- // base provider action
- //
- #define CRYPTPROTECT_DEFAULT_PROVIDER { 0xdf9d8cd0, 0x1501, 0x11d1, {0x8c, 0x7a, 0x00, 0xc0, 0x4f, 0xc2, 0x97, 0xeb} }
- //
- // CryptProtect PromptStruct dwPromtFlags
- //
- //
- // prompt on unprotect
- #define CRYPTPROTECT_PROMPT_ON_UNPROTECT 0x1 // 1<<0
- //
- // prompt on protect
- #define CRYPTPROTECT_PROMPT_ON_PROTECT 0x2 // 1<<1
- #define CRYPTPROTECT_PROMPT_RESERVED 0x04 // reserved, do not use.
- //
- // default to strong variant UI protection (user supplied password currently).
- #define CRYPTPROTECT_PROMPT_STRONG 0x08 // 1<<3
- //
- // require strong variant UI protection (user supplied password currently).
- #define CRYPTPROTECT_PROMPT_REQUIRE_STRONG 0x10 // 1<<4
- //
- // CryptProtectData and CryptUnprotectData dwFlags
- //
- // for remote-access situations where ui is not an option
- // if UI was specified on protect or unprotect operation, the call
- // will fail and GetLastError() will indicate ERROR_PASSWORD_RESTRICTION
- #define CRYPTPROTECT_UI_FORBIDDEN 0x1
- //
- // per machine protected data -- any user on machine where CryptProtectData
- // took place may CryptUnprotectData
- #define CRYPTPROTECT_LOCAL_MACHINE 0x4
- //
- // force credential synchronize during CryptProtectData()
- // Synchronize is only operation that occurs during this operation
- #define CRYPTPROTECT_CRED_SYNC 0x8
- //
- // Generate an Audit on protect and unprotect operations
- //
- #define CRYPTPROTECT_AUDIT 0x10
- //
- // Protect data with a non-recoverable key
- //
- #define CRYPTPROTECT_NO_RECOVERY 0x20
- //
- // Verify the protection of a protected blob
- //
- #define CRYPTPROTECT_VERIFY_PROTECTION 0x40
- //
- // Regenerate the local machine protection
- //
- #define CRYPTPROTECT_CRED_REGENERATE 0x80
- // flags reserved for system use
- #define CRYPTPROTECT_FIRST_RESERVED_FLAGVAL 0x0FFFFFFF
- #define CRYPTPROTECT_LAST_RESERVED_FLAGVAL 0xFFFFFFFF
- //
- // flags specific to base provider
- //
- WINCRYPT32API
- BOOL
- WINAPI
- CryptProtectData(
- IN DATA_BLOB* pDataIn,
- IN LPCWSTR szDataDescr,
- IN OPTIONAL DATA_BLOB* pOptionalEntropy,
- IN PVOID pvReserved,
- IN OPTIONAL CRYPTPROTECT_PROMPTSTRUCT* pPromptStruct,
- IN DWORD dwFlags,
- OUT DATA_BLOB* pDataOut // out encr blob
- );
- WINCRYPT32API
- BOOL
- WINAPI
- CryptUnprotectData(
- IN DATA_BLOB* pDataIn, // in encr blob
- OUT OPTIONAL LPWSTR* ppszDataDescr, // out
- IN OPTIONAL DATA_BLOB* pOptionalEntropy,
- IN PVOID pvReserved,
- IN OPTIONAL CRYPTPROTECT_PROMPTSTRUCT* pPromptStruct,
- IN DWORD dwFlags,
- OUT DATA_BLOB* pDataOut
- );
- //+=========================================================================
- // Helper functions to build certificates
- //==========================================================================
- //+-------------------------------------------------------------------------
- //
- // Builds a self-signed certificate and returns a PCCERT_CONTEXT representing
- // the certificate. A hProv must be specified to build the cert context.
- //
- // pSubjectIssuerBlob is the DN for the certifcate. If an alternate subject
- // name is desired it must be specified as an extension in the pExtensions
- // parameter. pSubjectIssuerBlob can NOT be NULL, so minimually an empty DN
- // must be specified.
- //
- // By default:
- // pKeyProvInfo - The CSP is queried for the KeyProvInfo parameters. Only the Provider,
- // Provider Type and Container is queried. Many CSPs don't support these
- // queries and will cause a failure. In such cases the pKeyProvInfo
- // must be specified (RSA BASE works fine).
- //
- // pSignatureAlgorithm - will default to SHA1RSA
- // pStartTime will default to the current time
- // pEndTime will default to 1 year
- // pEntensions will be empty.
- //
- // The returned PCCERT_CONTEXT will reference the private keys by setting the
- // CERT_KEY_PROV_INFO_PROP_ID. However, if this property is not desired specify the
- // CERT_CREATE_SELFSIGN_NO_KEY_INFO in dwFlags.
- //
- // If the cert being built is only a dummy placeholder cert for speed it may not
- // need to be signed. Signing of the cert is skipped if CERT_CREATE_SELFSIGN_NO_SIGN
- // is specified in dwFlags.
- //
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CONTEXT
- WINAPI
- CertCreateSelfSignCertificate(
- IN HCRYPTPROV hProv,
- IN PCERT_NAME_BLOB pSubjectIssuerBlob,
- IN DWORD dwFlags,
- OPTIONAL PCRYPT_KEY_PROV_INFO pKeyProvInfo,
- OPTIONAL PCRYPT_ALGORITHM_IDENTIFIER pSignatureAlgorithm,
- OPTIONAL PSYSTEMTIME pStartTime,
- OPTIONAL PSYSTEMTIME pEndTime,
- OPTIONAL PCERT_EXTENSIONS pExtensions
- );
- #define CERT_CREATE_SELFSIGN_NO_SIGN 1
- #define CERT_CREATE_SELFSIGN_NO_KEY_INFO 2
- //+=========================================================================
- // Key Identifier Property Data Structures and APIs
- //==========================================================================
- //+-------------------------------------------------------------------------
- // Get the property for the specified Key Identifier.
- //
- // The Key Identifier is the SHA1 hash of the encoded CERT_PUBLIC_KEY_INFO.
- // The Key Identifier for a certificate can be obtained by getting the
- // certificate's CERT_KEY_IDENTIFIER_PROP_ID. The
- // CryptCreateKeyIdentifierFromCSP API can be called to create the Key
- // Identifier from a CSP Public Key Blob.
- //
- // A Key Identifier can have the same properties as a certificate context.
- // CERT_KEY_PROV_INFO_PROP_ID is the property of most interest.
- // For CERT_KEY_PROV_INFO_PROP_ID, pvData points to a CRYPT_KEY_PROV_INFO
- // structure. Elements pointed to by fields in the pvData structure follow the
- // structure. Therefore, *pcbData will exceed the size of the structure.
- //
- // If CRYPT_KEYID_ALLOC_FLAG is set, then, *pvData is updated with a
- // pointer to allocated memory. LocalFree() must be called to free the
- // allocated memory.
- //
- // By default, searches the CurrentUser's list of Key Identifiers.
- // CRYPT_KEYID_MACHINE_FLAG can be set to search the LocalMachine's list
- // of Key Identifiers. When CRYPT_KEYID_MACHINE_FLAG is set, pwszComputerName
- // can also be set to specify the name of a remote computer to be searched
- // instead of the local machine.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptGetKeyIdentifierProperty(
- IN const CRYPT_HASH_BLOB *pKeyIdentifier,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN OPTIONAL LPCWSTR pwszComputerName,
- IN OPTIONAL void *pvReserved,
- OUT void *pvData,
- IN OUT DWORD *pcbData
- );
- // When the following flag is set, searches the LocalMachine instead of the
- // CurrentUser. This flag is applicable to all the KeyIdentifierProperty APIs.
- #define CRYPT_KEYID_MACHINE_FLAG 0x00000020
- // When the following flag is set, *pvData is updated with a pointer to
- // allocated memory. LocalFree() must be called to free the allocated memory.
- #define CRYPT_KEYID_ALLOC_FLAG 0x00008000
- //+-------------------------------------------------------------------------
- // Set the property for the specified Key Identifier.
- //
- // For CERT_KEY_PROV_INFO_PROP_ID pvData points to the
- // CRYPT_KEY_PROV_INFO data structure. For all other properties, pvData
- // points to a CRYPT_DATA_BLOB.
- //
- // Setting pvData == NULL, deletes the property.
- //
- // Set CRYPT_KEYID_MACHINE_FLAG to set the property for a LocalMachine
- // Key Identifier. Set pwszComputerName, to select a remote computer.
- //
- // If CRYPT_KEYID_DELETE_FLAG is set, the Key Identifier and all its
- // properties is deleted.
- //
- // If CRYPT_KEYID_SET_NEW_FLAG is set, the set fails if the property already
- // exists. For an existing property, FALSE is returned with LastError set to
- // CRYPT_E_EXISTS.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptSetKeyIdentifierProperty(
- IN const CRYPT_HASH_BLOB *pKeyIdentifier,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN OPTIONAL LPCWSTR pwszComputerName,
- IN OPTIONAL void *pvReserved,
- IN const void *pvData
- );
- // When the following flag is set, the Key Identifier and all its properties
- // are deleted.
- #define CRYPT_KEYID_DELETE_FLAG 0x00000010
- // When the following flag is set, the set fails if the property already
- // exists.
- #define CRYPT_KEYID_SET_NEW_FLAG 0x00002000
- //+-------------------------------------------------------------------------
- // For CERT_KEY_PROV_INFO_PROP_ID, rgppvData[] points to a
- // CRYPT_KEY_PROV_INFO.
- //
- // Return FALSE to stop the enumeration.
- //--------------------------------------------------------------------------
- typedef BOOL (WINAPI *PFN_CRYPT_ENUM_KEYID_PROP)(
- IN const CRYPT_HASH_BLOB *pKeyIdentifier,
- IN DWORD dwFlags,
- IN void *pvReserved,
- IN void *pvArg,
- IN DWORD cProp,
- IN DWORD *rgdwPropId,
- IN void **rgpvData,
- IN DWORD *rgcbData
- );
- //+-------------------------------------------------------------------------
- // Enumerate the Key Identifiers.
- //
- // If pKeyIdentifier is NULL, enumerates all Key Identifers. Otherwise,
- // calls the callback for the specified KeyIdentifier. If dwPropId is
- // 0, calls the callback with all the properties. Otherwise, only calls
- // the callback with the specified property (cProp = 1).
- // Furthermore, when dwPropId is specified, skips KeyIdentifiers not
- // having the property.
- //
- // Set CRYPT_KEYID_MACHINE_FLAG to enumerate the LocalMachine
- // Key Identifiers. Set pwszComputerName, to enumerate Key Identifiers on
- // a remote computer.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptEnumKeyIdentifierProperties(
- IN OPTIONAL const CRYPT_HASH_BLOB *pKeyIdentifier,
- IN DWORD dwPropId,
- IN DWORD dwFlags,
- IN OPTIONAL LPCWSTR pwszComputerName,
- IN OPTIONAL void *pvReserved,
- IN OPTIONAL void *pvArg,
- IN PFN_CRYPT_ENUM_KEYID_PROP pfnEnum
- );
- //+-------------------------------------------------------------------------
- // Create a KeyIdentifier from the CSP Public Key Blob.
- //
- // Converts the CSP PUBLICKEYSTRUC into a X.509 CERT_PUBLIC_KEY_INFO and
- // encodes. The encoded CERT_PUBLIC_KEY_INFO is SHA1 hashed to obtain
- // the Key Identifier.
- //
- // By default, the pPubKeyStruc->aiKeyAlg is used to find the appropriate
- // public key Object Identifier. pszPubKeyOID can be set to override
- // the default OID obtained from the aiKeyAlg.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CryptCreateKeyIdentifierFromCSP(
- IN DWORD dwCertEncodingType,
- IN OPTIONAL LPCSTR pszPubKeyOID,
- IN const PUBLICKEYSTRUC *pPubKeyStruc,
- IN DWORD cbPubKeyStruc,
- IN DWORD dwFlags,
- IN OPTIONAL void *pvReserved,
- OUT BYTE *pbHash,
- IN OUT DWORD *pcbHash
- );
- //+=========================================================================
- // Certificate Chaining Infrastructure
- //==========================================================================
- #define CERT_CHAIN_CONFIG_REGPATH \
- L"Software\\Microsoft\\Cryptography\\OID\\EncodingType 0\\CertDllCreateCertificateChainEngine\\Config"
- // The following are REG_DWORD's. These configuration parameters are used
- // to restrict Authority Info Access (AIA) URL retrieval.
- #define CERT_CHAIN_DISABLE_AIA_URL_RETRIEVAL_VALUE_NAME \
- L"DisableAIAUrlRetrieval"
- // By default AIA Url Retrieval is enabled. Set this registry value to nonzero
- // to disable
- #define CERT_CHAIN_MAX_AIA_URL_COUNT_IN_CERT_VALUE_NAME \
- L"MaxAIAUrlCountInCert"
- #define CERT_CHAIN_MAX_AIA_URL_COUNT_IN_CERT_DEFAULT 5
- #define CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_COUNT_PER_CHAIN_VALUE_NAME \
- L"MaxAIAUrlRetrievalCountPerChain"
- #define CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_COUNT_PER_CHAIN_DEFAULT 10
- #define CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_BYTE_COUNT_VALUE_NAME \
- L"MaxAIAUrlRetrievalByteCount"
- #define CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_BYTE_COUNT_DEFAULT 100000
- #define CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_CERT_COUNT_VALUE_NAME \
- L"MaxAIAUrlRetrievalCertCount"
- #define CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_CERT_COUNT_DEFAULT 10
- //
- // The chain engine defines the store namespace and cache partitioning for
- // the Certificate Chaining infrastructure. A default chain engine
- // is defined for the process which uses all default system stores e.g.
- // Root, CA, Trust, for chain building and caching. If an application
- // wishes to define its own store namespace or have its own partitioned
- // cache then it can create its own chain engine. It is advisable to create
- // a chain engine at application startup and use it throughout the lifetime
- // of the application in order to get optimal caching behavior
- //
- typedef HANDLE HCERTCHAINENGINE;
- #define HCCE_CURRENT_USER ((HCERTCHAINENGINE)NULL)
- #define HCCE_LOCAL_MACHINE ((HCERTCHAINENGINE)0x1)
- //
- // Create a certificate chain engine.
- //
- //
- // Configuration parameters for the certificate chain engine
- //
- // hRestrictedRoot - restrict the root store (must be a subset of "Root")
- //
- // hRestrictedTrust - restrict the store for CTLs
- //
- // hRestrictedOther - restrict the store for certs and CRLs
- //
- // cAdditionalStore, rghAdditionalStore - additional stores
- //
- // NOTE: The algorithm used to define the stores for the engine is as
- // follows:
- //
- // hRoot = hRestrictedRoot or System Store "Root"
- //
- // hTrust = hRestrictedTrust or hWorld (defined later)
- //
- // hOther = hRestrictedOther or (hRestrictedTrust == NULL) ? hWorld :
- // hRestrictedTrust + hWorld
- //
- // hWorld = hRoot + "CA" + "My" + "Trust" + rghAdditionalStore
- //
- // dwFlags - flags
- //
- // CERT_CHAIN_CACHE_END_CERT - information will be cached on
- // the end cert as well as the other
- // certs in the chain
- //
- // CERT_CHAIN_THREAD_STORE_SYNC - use separate thread for store syncs
- // and related cache updates
- //
- // CERT_CHAIN_CACHE_ONLY_URL_RETRIEVAL - don't hit the wire to get
- // URL based objects
- //
- // dwUrlRetrievalTimeout - timeout for wire based URL object retrievals
- // (milliseconds)
- //
- #define CERT_CHAIN_CACHE_END_CERT 0x00000001
- #define CERT_CHAIN_THREAD_STORE_SYNC 0x00000002
- #define CERT_CHAIN_CACHE_ONLY_URL_RETRIEVAL 0x00000004
- #define CERT_CHAIN_USE_LOCAL_MACHINE_STORE 0x00000008
- #define CERT_CHAIN_ENABLE_CACHE_AUTO_UPDATE 0x00000010
- #define CERT_CHAIN_ENABLE_SHARE_STORE 0x00000020
- typedef struct _CERT_CHAIN_ENGINE_CONFIG {
- DWORD cbSize;
- HCERTSTORE hRestrictedRoot;
- HCERTSTORE hRestrictedTrust;
- HCERTSTORE hRestrictedOther;
- DWORD cAdditionalStore;
- HCERTSTORE* rghAdditionalStore;
- DWORD dwFlags;
- DWORD dwUrlRetrievalTimeout; // milliseconds
- DWORD MaximumCachedCertificates;
- DWORD CycleDetectionModulus;
- } CERT_CHAIN_ENGINE_CONFIG, *PCERT_CHAIN_ENGINE_CONFIG;
- WINCRYPT32API
- BOOL
- WINAPI
- CertCreateCertificateChainEngine (
- IN PCERT_CHAIN_ENGINE_CONFIG pConfig,
- OUT HCERTCHAINENGINE* phChainEngine
- );
- //
- // Free a certificate trust engine
- //
- WINCRYPT32API
- VOID
- WINAPI
- CertFreeCertificateChainEngine (
- IN HCERTCHAINENGINE hChainEngine
- );
- //
- // Resync the certificate chain engine. This resync's the stores backing
- // the engine and updates the engine caches.
- //
- WINCRYPT32API
- BOOL
- WINAPI
- CertResyncCertificateChainEngine (
- IN HCERTCHAINENGINE hChainEngine
- );
- //
- // When an application requests a certificate chain, the data structure
- // returned is in the form of a CERT_CHAIN_CONTEXT. This contains
- // an array of CERT_SIMPLE_CHAIN where each simple chain goes from
- // an end cert to a self signed cert and the chain context connects simple
- // chains via trust lists. Each simple chain contains the chain of
- // certificates, summary trust information about the chain and trust information
- // about each certificate element in the chain.
- //
- //
- // Trust status bits
- //
- typedef struct _CERT_TRUST_STATUS {
- DWORD dwErrorStatus;
- DWORD dwInfoStatus;
- } CERT_TRUST_STATUS, *PCERT_TRUST_STATUS;
- //
- // The following are error status bits
- //
- // These can be applied to certificates and chains
- #define CERT_TRUST_NO_ERROR 0x00000000
- #define CERT_TRUST_IS_NOT_TIME_VALID 0x00000001
- #define CERT_TRUST_IS_NOT_TIME_NESTED 0x00000002
- #define CERT_TRUST_IS_REVOKED 0x00000004
- #define CERT_TRUST_IS_NOT_SIGNATURE_VALID 0x00000008
- #define CERT_TRUST_IS_NOT_VALID_FOR_USAGE 0x00000010
- #define CERT_TRUST_IS_UNTRUSTED_ROOT 0x00000020
- #define CERT_TRUST_REVOCATION_STATUS_UNKNOWN 0x00000040
- #define CERT_TRUST_IS_CYCLIC 0x00000080
- #define CERT_TRUST_INVALID_EXTENSION 0x00000100
- #define CERT_TRUST_INVALID_POLICY_CONSTRAINTS 0x00000200
- #define CERT_TRUST_INVALID_BASIC_CONSTRAINTS 0x00000400
- #define CERT_TRUST_INVALID_NAME_CONSTRAINTS 0x00000800
- #define CERT_TRUST_HAS_NOT_SUPPORTED_NAME_CONSTRAINT 0x00001000
- #define CERT_TRUST_HAS_NOT_DEFINED_NAME_CONSTRAINT 0x00002000
- #define CERT_TRUST_HAS_NOT_PERMITTED_NAME_CONSTRAINT 0x00004000
- #define CERT_TRUST_HAS_EXCLUDED_NAME_CONSTRAINT 0x00008000
- #define CERT_TRUST_IS_OFFLINE_REVOCATION 0x01000000
- #define CERT_TRUST_NO_ISSUANCE_CHAIN_POLICY 0x02000000
- // These can be applied to chains only
- #define CERT_TRUST_IS_PARTIAL_CHAIN 0x00010000
- #define CERT_TRUST_CTL_IS_NOT_TIME_VALID 0x00020000
- #define CERT_TRUST_CTL_IS_NOT_SIGNATURE_VALID 0x00040000
- #define CERT_TRUST_CTL_IS_NOT_VALID_FOR_USAGE 0x00080000
- //
- // The following are info status bits
- //
- // These can be applied to certificates only
- #define CERT_TRUST_HAS_EXACT_MATCH_ISSUER 0x00000001
- #define CERT_TRUST_HAS_KEY_MATCH_ISSUER 0x00000002
- #define CERT_TRUST_HAS_NAME_MATCH_ISSUER 0x00000004
- #define CERT_TRUST_IS_SELF_SIGNED 0x00000008
- // These can be applied to certificates and chains
- #define CERT_TRUST_HAS_PREFERRED_ISSUER 0x00000100
- #define CERT_TRUST_HAS_ISSUANCE_CHAIN_POLICY 0x00000200
- #define CERT_TRUST_HAS_VALID_NAME_CONSTRAINTS 0x00000400
- // These can be applied to chains only
- #define CERT_TRUST_IS_COMPLEX_CHAIN 0x00010000
- //
- // Each certificate context in a simple chain has a corresponding chain element
- // in the simple chain context
- //
- // dwErrorStatus has CERT_TRUST_IS_REVOKED, pRevocationInfo set
- // dwErrorStatus has CERT_TRUST_REVOCATION_STATUS_UNKNOWN, pRevocationInfo set
- //
- // Note that the post processing revocation supported in the first
- // version only sets cbSize and dwRevocationResult. Everything else
- // is NULL
- //
- //
- // Revocation Information
- //
- typedef struct _CERT_REVOCATION_INFO {
- DWORD cbSize;
- DWORD dwRevocationResult;
- LPCSTR pszRevocationOid;
- LPVOID pvOidSpecificInfo;
- // fHasFreshnessTime is only set if we are able to retrieve revocation
- // information. For a CRL its CurrentTime - ThisUpdate.
- BOOL fHasFreshnessTime;
- DWORD dwFreshnessTime; // seconds
- // NonNULL for CRL base revocation checking
- PCERT_REVOCATION_CRL_INFO pCrlInfo;
- } CERT_REVOCATION_INFO, *PCERT_REVOCATION_INFO;
- //
- // Trust List Information
- //
- typedef struct _CERT_TRUST_LIST_INFO {
- DWORD cbSize;
- PCTL_ENTRY pCtlEntry;
- PCCTL_CONTEXT pCtlContext;
- } CERT_TRUST_LIST_INFO, *PCERT_TRUST_LIST_INFO;
- //
- // Chain Element
- //
- typedef struct _CERT_CHAIN_ELEMENT {
- DWORD cbSize;
- PCCERT_CONTEXT pCertContext;
- CERT_TRUST_STATUS TrustStatus;
- PCERT_REVOCATION_INFO pRevocationInfo;
- PCERT_ENHKEY_USAGE pIssuanceUsage; // If NULL, any
- PCERT_ENHKEY_USAGE pApplicationUsage; // If NULL, any
- LPCWSTR pwszExtendedErrorInfo; // If NULL, none
- } CERT_CHAIN_ELEMENT, *PCERT_CHAIN_ELEMENT;
- //
- // The simple chain is an array of chain elements and a summary trust status
- // for the chain
- //
- // rgpElements[0] is the end certificate chain element
- //
- // rgpElements[cElement-1] is the self-signed "root" certificate chain element
- //
- typedef struct _CERT_SIMPLE_CHAIN {
- DWORD cbSize;
- CERT_TRUST_STATUS TrustStatus;
- DWORD cElement;
- PCERT_CHAIN_ELEMENT* rgpElement;
- PCERT_TRUST_LIST_INFO pTrustListInfo;
- // fHasRevocationFreshnessTime is only set if we are able to retrieve
- // revocation information for all elements checked for revocation.
- // For a CRL its CurrentTime - ThisUpdate.
- //
- // dwRevocationFreshnessTime is the largest time across all elements
- // checked.
- BOOL fHasRevocationFreshnessTime;
- DWORD dwRevocationFreshnessTime; // seconds
- } CERT_SIMPLE_CHAIN, *PCERT_SIMPLE_CHAIN;
- //
- // And the chain context contains an array of simple chains and summary trust
- // status for all the connected simple chains
- //
- // rgpChains[0] is the end certificate simple chain
- //
- // rgpChains[cChain-1] is the final (possibly trust list signer) chain which
- // ends in a certificate which is contained in the root store
- //
- typedef struct _CERT_CHAIN_CONTEXT CERT_CHAIN_CONTEXT, *PCERT_CHAIN_CONTEXT;
- typedef const CERT_CHAIN_CONTEXT *PCCERT_CHAIN_CONTEXT;
- struct _CERT_CHAIN_CONTEXT {
- DWORD cbSize;
- CERT_TRUST_STATUS TrustStatus;
- DWORD cChain;
- PCERT_SIMPLE_CHAIN* rgpChain;
- // Following is returned when CERT_CHAIN_RETURN_LOWER_QUALITY_CONTEXTS
- // is set in dwFlags
- DWORD cLowerQualityChainContext;
- PCCERT_CHAIN_CONTEXT* rgpLowerQualityChainContext;
- // fHasRevocationFreshnessTime is only set if we are able to retrieve
- // revocation information for all elements checked for revocation.
- // For a CRL its CurrentTime - ThisUpdate.
- //
- // dwRevocationFreshnessTime is the largest time across all elements
- // checked.
- BOOL fHasRevocationFreshnessTime;
- DWORD dwRevocationFreshnessTime; // seconds
- };
- //
- // When building a chain, the there are various parameters used for finding
- // issuing certificates and trust lists. They are identified in the
- // following structure
- //
- // Default usage match type is AND with value zero
- #define USAGE_MATCH_TYPE_AND 0x00000000
- #define USAGE_MATCH_TYPE_OR 0x00000001
- typedef struct _CERT_USAGE_MATCH {
- DWORD dwType;
- CERT_ENHKEY_USAGE Usage;
- } CERT_USAGE_MATCH, *PCERT_USAGE_MATCH;
- typedef struct _CTL_USAGE_MATCH {
- DWORD dwType;
- CTL_USAGE Usage;
- } CTL_USAGE_MATCH, *PCTL_USAGE_MATCH;
- typedef struct _CERT_CHAIN_PARA {
- DWORD cbSize;
- CERT_USAGE_MATCH RequestedUsage;
- #ifdef CERT_CHAIN_PARA_HAS_EXTRA_FIELDS
- // Note, if you #define CERT_CHAIN_PARA_HAS_EXTRA_FIELDS, then, you
- // must zero all unused fields in this data structure.
- // More fields could be added in a future release.
- CERT_USAGE_MATCH RequestedIssuancePolicy;
- DWORD dwUrlRetrievalTimeout; // milliseconds
- BOOL fCheckRevocationFreshnessTime;
- DWORD dwRevocationFreshnessTime; // seconds
- #endif
- } CERT_CHAIN_PARA, *PCERT_CHAIN_PARA;
- //
- // The following API is used for retrieving certificate chains
- //
- // Parameters:
- //
- // hChainEngine - the chain engine (namespace and cache) to use, NULL
- // mean use the default chain engine
- //
- // pCertContext - the context we are retrieving the chain for, it
- // will be the zero index element in the chain
- //
- // pTime - the point in time that we want the chain validated
- // for. Note that the time does not affect trust list,
- // revocation, or root store checking. NULL means use
- // the current system time
- //
- // hAdditionalStore - additional store to use when looking up objects
- //
- // pChainPara - parameters for chain building
- //
- // dwFlags - flags such as should revocation checking be done
- // on the chain?
- //
- // pvReserved - reserved parameter, must be NULL
- //
- // ppChainContext - chain context returned
- //
- // CERT_CHAIN_CACHE_END_CERT can be used here as well
- // Revocation flags are in the high nibble
- #define CERT_CHAIN_REVOCATION_CHECK_END_CERT 0x10000000
- #define CERT_CHAIN_REVOCATION_CHECK_CHAIN 0x20000000
- #define CERT_CHAIN_REVOCATION_CHECK_CHAIN_EXCLUDE_ROOT 0x40000000
- #define CERT_CHAIN_REVOCATION_CHECK_CACHE_ONLY 0x80000000
- // By default, the dwUrlRetrievalTimeout in pChainPara is the timeout used
- // for each revocation URL wire retrieval. When the following flag is set,
- // dwUrlRetrievalTimeout is the accumulative timeout across all
- // revocation URL wire retrievals.
- #define CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT 0x08000000
- // First pass determines highest quality based upon:
- // - Chain signature valid (higest quality bit of this set)
- // - Complete chain
- // - Trusted root (lowestest quality bit of this set)
- // By default, second pass only considers paths >= highest first pass quality
- #define CERT_CHAIN_DISABLE_PASS1_QUALITY_FILTERING 0x00000040
- #define CERT_CHAIN_RETURN_LOWER_QUALITY_CONTEXTS 0x00000080
- #define CERT_CHAIN_DISABLE_AUTH_ROOT_AUTO_UPDATE 0x00000100
- // When this flag is set, pTime will be used as the timestamp time.
- // pTime will be used to determine if the end certificate was valid at this
- // time. Revocation checking will be relative to pTime.
- // In addition, current time will also be used
- // to determine if the certificate is still time valid. All remaining
- // CA and root certificates will be checked using current time and not pTime.
- //
- // This flag was added 4/5/01 in WXP.
- #define CERT_CHAIN_TIMESTAMP_TIME 0x00000200
- WINCRYPT32API
- BOOL
- WINAPI
- CertGetCertificateChain (
- IN OPTIONAL HCERTCHAINENGINE hChainEngine,
- IN PCCERT_CONTEXT pCertContext,
- IN OPTIONAL LPFILETIME pTime,
- IN OPTIONAL HCERTSTORE hAdditionalStore,
- IN PCERT_CHAIN_PARA pChainPara,
- IN DWORD dwFlags,
- IN LPVOID pvReserved,
- OUT PCCERT_CHAIN_CONTEXT* ppChainContext
- );
- //
- // Free a certificate chain
- //
- WINCRYPT32API
- VOID
- WINAPI
- CertFreeCertificateChain (
- IN PCCERT_CHAIN_CONTEXT pChainContext
- );
- //
- // Duplicate (add a reference to) a certificate chain
- //
- WINCRYPT32API
- PCCERT_CHAIN_CONTEXT
- WINAPI
- CertDuplicateCertificateChain (
- IN PCCERT_CHAIN_CONTEXT pChainContext
- );
- //
- // Specific Revocation Type OID and structure definitions
- //
- //
- // CRL Revocation OID
- //
- #define REVOCATION_OID_CRL_REVOCATION ((LPCSTR)1)
- //
- // For the CRL revocation OID the pvRevocationPara is NULL
- //
- //
- // CRL Revocation Info
- //
- typedef struct _CRL_REVOCATION_INFO {
- PCRL_ENTRY pCrlEntry;
- PCCRL_CONTEXT pCrlContext;
- PCCERT_CHAIN_CONTEXT pCrlIssuerChain;
- } CRL_REVOCATION_INFO, *PCRL_REVOCATION_INFO;
- //+-------------------------------------------------------------------------
- // Find the first or next certificate chain context in the store.
- //
- // The chain context is found according to the dwFindFlags, dwFindType and
- // its pvFindPara. See below for a list of the find types and its parameters.
- //
- // If the first or next chain context isn't found, NULL is returned.
- // Otherwise, a pointer to a read only CERT_CHAIN_CONTEXT is returned.
- // CERT_CHAIN_CONTEXT must be freed by calling CertFreeCertificateChain
- // or is freed when passed as the
- // pPrevChainContext on a subsequent call. CertDuplicateCertificateChain
- // can be called to make a duplicate.
- //
- // pPrevChainContext MUST BE NULL on the first
- // call to find the chain context. To find the next chain context, the
- // pPrevChainContext is set to the CERT_CHAIN_CONTEXT returned by a previous
- // call.
- //
- // NOTE: a NON-NULL pPrevChainContext is always CertFreeCertificateChain'ed by
- // this function, even for an error.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- PCCERT_CHAIN_CONTEXT
- WINAPI
- CertFindChainInStore(
- IN HCERTSTORE hCertStore,
- IN DWORD dwCertEncodingType,
- IN DWORD dwFindFlags,
- IN DWORD dwFindType,
- IN const void *pvFindPara,
- IN PCCERT_CHAIN_CONTEXT pPrevChainContext
- );
- #define CERT_CHAIN_FIND_BY_ISSUER 1
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_FIND_BY_ISSUER
- //
- // Find a certificate chain having a private key for the end certificate and
- // matching one of the given issuer names. A matching dwKeySpec and
- // enhanced key usage can also be specified. Additionally a callback can
- // be provided for even more caller provided filtering before building the
- // chain.
- //
- // By default, only the issuers in the first simple chain are compared
- // for a name match. CERT_CHAIN_FIND_BY_ISSUER_COMPLEX_CHAIN_FLAG can
- // be set in dwFindFlags to match issuers in all the simple chains.
- //
- // CERT_CHAIN_FIND_BY_ISSUER_NO_KEY_FLAG can be set in dwFindFlags to
- // not check if the end certificate has a private key.
- //
- // CERT_CHAIN_FIND_BY_ISSUER_COMPARE_KEY_FLAG can be set in dwFindFlags
- // to compare the public key in the end certificate with the crypto
- // provider's public key. The dwAcquirePrivateKeyFlags can be set
- // in CERT_CHAIN_FIND_BY_ISSUER_PARA to enable caching of the private key's
- // HKEY returned by the CSP.
- //
- // If dwCertEncodingType == 0, defaults to X509_ASN_ENCODING for the
- // array of encoded issuer names.
- //
- // By default, the hCertStore passed to CertFindChainInStore, is passed
- // as an additional store to CertGetCertificateChain.
- // CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_FLAG can be set in dwFindFlags
- // to improve performance by only searching the cached system stores
- // (root, my, ca, trust) to find the issuer certificates. If you are doing
- // a find in the "my" system store, than, this flag should be set to
- // improve performance.
- //
- // Setting CERT_CHAIN_FIND_BY_ISSUER_LOCAL_MACHINE_FLAG in dwFindFlags
- // restricts CertGetCertificateChain to search the Local Machine
- // cached system stores instead of the Current User's.
- //
- // Setting CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_URL_FLAG in dwFindFlags
- // restricts CertGetCertificateChain to only search the URL cache
- // and not hit the wire.
- //--------------------------------------------------------------------------
- // Returns FALSE to skip this certificate. Otherwise, returns TRUE to
- // build a chain for this certificate.
- typedef BOOL (WINAPI *PFN_CERT_CHAIN_FIND_BY_ISSUER_CALLBACK)(
- IN PCCERT_CONTEXT pCert,
- IN void *pvFindArg
- );
- typedef struct _CERT_CHAIN_FIND_BY_ISSUER_PARA {
- DWORD cbSize;
- // If pszUsageIdentifier == NULL, matches any usage.
- LPCSTR pszUsageIdentifier;
- // If dwKeySpec == 0, matches any KeySpec
- DWORD dwKeySpec;
- // When CERT_CHAIN_FIND_BY_ISSUER_COMPARE_KEY_FLAG is set in dwFindFlags,
- // CryptAcquireCertificatePrivateKey is called to do the public key
- // comparison. The following flags can be set to enable caching
- // of the acquired private key or suppress CSP UI. See the API for more
- // details on these flags.
- DWORD dwAcquirePrivateKeyFlags;
- // Pointer to an array of X509, ASN.1 encoded issuer name blobs. If
- // cIssuer == 0, matches any issuer
- DWORD cIssuer;
- CERT_NAME_BLOB *rgIssuer;
- // If NULL or Callback returns TRUE, builds the chain for the end
- // certificate having a private key with the specified KeySpec and
- // enhanced key usage.
- PFN_CERT_CHAIN_FIND_BY_ISSUER_CALLBACK pfnFindCallback;
- void *pvFindArg;
- #ifdef CERT_CHAIN_FIND_BY_ISSUER_PARA_HAS_EXTRA_FIELDS
- // Note, if you #define CERT_CHAIN_FIND_BY_ISSUER_PARA_HAS_EXTRA_FIELDS,
- // then, you must zero all unused fields in this data structure.
- // More fields could be added in a future release.
- // If the following pointers are nonNull, returns the index of the
- // matching issuer certificate, which is at:
- // pChainContext->
- // rgpChain[*pdwIssuerChainIndex]->rgpElement[*pdwIssuerElementIndex].
- //
- // The issuer name blob is compared against the Issuer field in the
- // certificate. The *pdwIssuerElementIndex is set to the index of this
- // subject certificate + 1. Therefore, its possible for a partial chain or
- // a self signed certificate matching the name blob, where
- // *pdwIssuerElementIndex points past the last certificate in the chain.
- //
- // Note, not updated if the above cIssuer == 0.
- DWORD *pdwIssuerChainIndex;
- DWORD *pdwIssuerElementIndex;
- #endif
- } CERT_CHAIN_FIND_ISSUER_PARA, *PCERT_CHAIN_FIND_ISSUER_PARA,
- CERT_CHAIN_FIND_BY_ISSUER_PARA, *PCERT_CHAIN_FIND_BY_ISSUER_PARA;
- // The following dwFindFlags can be set for CERT_CHAIN_FIND_BY_ISSUER
- // If set, compares the public key in the end certificate with the crypto
- // provider's public key. This comparison is the last check made on the
- // build chain.
- #define CERT_CHAIN_FIND_BY_ISSUER_COMPARE_KEY_FLAG 0x0001
- // If not set, only checks the first simple chain for an issuer name match.
- // When set, also checks second and subsequent simple chains.
- #define CERT_CHAIN_FIND_BY_ISSUER_COMPLEX_CHAIN_FLAG 0x0002
- // If set, CertGetCertificateChain only searches the URL cache and
- // doesn't hit the wire.
- #define CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_URL_FLAG 0x0004
- // If set, CertGetCertificateChain only opens the Local Machine
- // certificate stores instead of the Current User's.
- #define CERT_CHAIN_FIND_BY_ISSUER_LOCAL_MACHINE_FLAG 0x0008
- // If set, no check is made to see if the end certificate has a private
- // key associated with it.
- #define CERT_CHAIN_FIND_BY_ISSUER_NO_KEY_FLAG 0x4000
- // By default, the hCertStore passed to CertFindChainInStore, is passed
- // as the additional store to CertGetCertificateChain. This flag can be
- // set to improve performance by only searching the cached system stores
- // (root, my, ca, trust) to find the issuer certificates. If not set, then,
- // the hCertStore is always searched in addition to the cached system
- // stores.
- #define CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_FLAG 0x8000
- //+=========================================================================
- // Certificate Chain Policy Data Structures and APIs
- //==========================================================================
- typedef struct _CERT_CHAIN_POLICY_PARA {
- DWORD cbSize;
- DWORD dwFlags;
- void *pvExtraPolicyPara; // pszPolicyOID specific
- } CERT_CHAIN_POLICY_PARA, *PCERT_CHAIN_POLICY_PARA;
- // If both lChainIndex and lElementIndex are set to -1, the dwError applies
- // to the whole chain context. If only lElementIndex is set to -1, the
- // dwError applies to the lChainIndex'ed chain. Otherwise, the dwError applies
- // to the certificate element at
- // pChainContext->rgpChain[lChainIndex]->rgpElement[lElementIndex].
- typedef struct _CERT_CHAIN_POLICY_STATUS {
- DWORD cbSize;
- DWORD dwError;
- LONG lChainIndex;
- LONG lElementIndex;
- void *pvExtraPolicyStatus; // pszPolicyOID specific
- } CERT_CHAIN_POLICY_STATUS, *PCERT_CHAIN_POLICY_STATUS;
- // Common chain policy flags
- #define CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG 0x00000001
- #define CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG 0x00000002
- #define CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG 0x00000004
- #define CERT_CHAIN_POLICY_IGNORE_INVALID_BASIC_CONSTRAINTS_FLAG 0x00000008
- #define CERT_CHAIN_POLICY_IGNORE_ALL_NOT_TIME_VALID_FLAGS ( \
- CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG | \
- CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG | \
- CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG \
- )
- #define CERT_CHAIN_POLICY_ALLOW_UNKNOWN_CA_FLAG 0x00000010
- #define CERT_CHAIN_POLICY_IGNORE_WRONG_USAGE_FLAG 0x00000020
- #define CERT_CHAIN_POLICY_IGNORE_INVALID_NAME_FLAG 0x00000040
- #define CERT_CHAIN_POLICY_IGNORE_INVALID_POLICY_FLAG 0x00000080
- #define CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG 0x00000100
- #define CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG 0x00000200
- #define CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG 0x00000400
- #define CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG 0x00000800
- #define CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS ( \
- CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG | \
- CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG | \
- CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG | \
- CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG \
- )
- #define CERT_CHAIN_POLICY_ALLOW_TESTROOT_FLAG 0x00008000
- #define CERT_CHAIN_POLICY_TRUST_TESTROOT_FLAG 0x00004000
- //+-------------------------------------------------------------------------
- // Verify that the certificate chain satisfies the specified policy
- // requirements. If we were able to verify the chain policy, TRUE is returned
- // and the dwError field of the pPolicyStatus is updated. A dwError of 0
- // (ERROR_SUCCESS, S_OK) indicates the chain satisfies the specified policy.
- //
- // If dwError applies to the entire chain context, both lChainIndex and
- // lElementIndex are set to -1. If dwError applies to a simple chain,
- // lElementIndex is set to -1 and lChainIndex is set to the index of the
- // first offending chain having the error. If dwError applies to a
- // certificate element, lChainIndex and lElementIndex are updated to
- // index the first offending certificate having the error, where, the
- // the certificate element is at:
- // pChainContext->rgpChain[lChainIndex]->rgpElement[lElementIndex].
- //
- // The dwFlags in pPolicyPara can be set to change the default policy checking
- // behaviour. In addition, policy specific parameters can be passed in
- // the pvExtraPolicyPara field of pPolicyPara.
- //
- // In addition to returning dwError, in pPolicyStatus, policy OID specific
- // extra status may be returned via pvExtraPolicyStatus.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- CertVerifyCertificateChainPolicy(
- IN LPCSTR pszPolicyOID,
- IN PCCERT_CHAIN_CONTEXT pChainContext,
- IN PCERT_CHAIN_POLICY_PARA pPolicyPara,
- IN OUT PCERT_CHAIN_POLICY_STATUS pPolicyStatus
- );
- // Predefined OID Function Names
- #define CRYPT_OID_VERIFY_CERTIFICATE_CHAIN_POLICY_FUNC \
- "CertDllVerifyCertificateChainPolicy"
- // CertDllVerifyCertificateChainPolicy has same function signature as
- // CertVerifyCertificateChainPolicy.
- //+-------------------------------------------------------------------------
- // Predefined verify chain policies
- //--------------------------------------------------------------------------
- #define CERT_CHAIN_POLICY_BASE ((LPCSTR) 1)
- #define CERT_CHAIN_POLICY_AUTHENTICODE ((LPCSTR) 2)
- #define CERT_CHAIN_POLICY_AUTHENTICODE_TS ((LPCSTR) 3)
- #define CERT_CHAIN_POLICY_SSL ((LPCSTR) 4)
- #define CERT_CHAIN_POLICY_BASIC_CONSTRAINTS ((LPCSTR) 5)
- #define CERT_CHAIN_POLICY_NT_AUTH ((LPCSTR) 6)
- #define CERT_CHAIN_POLICY_MICROSOFT_ROOT ((LPCSTR) 7)
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_POLICY_BASE
- //
- // Implements the base chain policy verification checks. dwFlags can
- // be set in pPolicyPara to alter the default policy checking behaviour.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_POLICY_AUTHENTICODE
- //
- // Implements the Authenticode chain policy verification checks.
- //
- // pvExtraPolicyPara may optionally be set to point to the following
- // AUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_PARA.
- //
- // pvExtraPolicyStatus may optionally be set to point to the following
- // AUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_STATUS.
- //--------------------------------------------------------------------------
- // dwRegPolicySettings are defined in wintrust.h
- typedef struct _AUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_PARA {
- DWORD cbSize;
- DWORD dwRegPolicySettings;
- PCMSG_SIGNER_INFO pSignerInfo; // optional
- } AUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_PARA,
- *PAUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_PARA;
- typedef struct _AUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_STATUS {
- DWORD cbSize;
- BOOL fCommercial; // obtained from signer statement
- } AUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_STATUS,
- *PAUTHENTICODE_EXTRA_CERT_CHAIN_POLICY_STATUS;
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_POLICY_AUTHENTICODE_TS
- //
- // Implements the Authenticode Time Stamp chain policy verification checks.
- //
- // pvExtraPolicyPara may optionally be set to point to the following
- // AUTHENTICODE_TS_EXTRA_CERT_CHAIN_POLICY_PARA.
- //
- // pvExtraPolicyStatus isn't used and must be set to NULL.
- //--------------------------------------------------------------------------
- // dwRegPolicySettings are defined in wintrust.h
- typedef struct _AUTHENTICODE_TS_EXTRA_CERT_CHAIN_POLICY_PARA {
- DWORD cbSize;
- DWORD dwRegPolicySettings;
- BOOL fCommercial;
- } AUTHENTICODE_TS_EXTRA_CERT_CHAIN_POLICY_PARA,
- *PAUTHENTICODE_TS_EXTRA_CERT_CHAIN_POLICY_PARA;
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_POLICY_SSL
- //
- // Implements the SSL client/server chain policy verification checks.
- //
- // pvExtraPolicyPara may optionally be set to point to the following
- // SSL_EXTRA_CERT_CHAIN_POLICY_PARA data structure
- //--------------------------------------------------------------------------
- // fdwChecks flags are defined in wininet.h
- typedef struct _HTTPSPolicyCallbackData
- {
- union {
- DWORD cbStruct; // sizeof(HTTPSPolicyCallbackData);
- DWORD cbSize; // sizeof(HTTPSPolicyCallbackData);
- };
- DWORD dwAuthType;
- # define AUTHTYPE_CLIENT 1
- # define AUTHTYPE_SERVER 2
- DWORD fdwChecks;
- WCHAR *pwszServerName; // used to check against CN=xxxx
- } HTTPSPolicyCallbackData, *PHTTPSPolicyCallbackData,
- SSL_EXTRA_CERT_CHAIN_POLICY_PARA, *PSSL_EXTRA_CERT_CHAIN_POLICY_PARA;
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_POLICY_BASIC_CONSTRAINTS
- //
- // Implements the basic constraints chain policy.
- //
- // Iterates through all the certificates in the chain checking for either
- // a szOID_BASIC_CONSTRAINTS or a szOID_BASIC_CONSTRAINTS2 extension. If
- // neither extension is present, the certificate is assumed to have
- // valid policy. Otherwise, for the first certificate element, checks if
- // it matches the expected CA_FLAG or END_ENTITY_FLAG specified in
- // pPolicyPara->dwFlags. If neither or both flags are set, then, the first
- // element can be either a CA or END_ENTITY. All other elements must be
- // a CA. If the PathLenConstraint is present in the extension, its
- // checked.
- //
- // The first elements in the remaining simple chains (ie, the certificate
- // used to sign the CTL) are checked to be an END_ENTITY.
- //
- // If this verification fails, dwError will be set to
- // TRUST_E_BASIC_CONSTRAINTS.
- //--------------------------------------------------------------------------
- #define BASIC_CONSTRAINTS_CERT_CHAIN_POLICY_CA_FLAG 0x80000000
- #define BASIC_CONSTRAINTS_CERT_CHAIN_POLICY_END_ENTITY_FLAG 0x40000000
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_POLICY_NT_AUTH
- //
- // Implements the NT Authentication chain policy.
- //
- // The NT Authentication chain policy consists of 3 distinct chain
- // verifications in the following order:
- // [1] CERT_CHAIN_POLICY_BASE - Implements the base chain policy
- // verification checks. The LOWORD of dwFlags can be set in
- // pPolicyPara to alter the default policy checking behaviour. See
- // CERT_CHAIN_POLICY_BASE for more details.
- //
- // [2] CERT_CHAIN_POLICY_BASIC_CONSTRAINTS - Implements the basic
- // constraints chain policy. The HIWORD of dwFlags can be set
- // to specify if the first element must be either a CA or END_ENTITY.
- // See CERT_CHAIN_POLICY_BASIC_CONSTRAINTS for more details.
- //
- // [3] Checks if the second element in the chain, the CA that issued
- // the end certificate, is a trusted CA for NT
- // Authentication. A CA is considered to be trusted if it exists in
- // the "NTAuth" system registry store found in the
- // CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE store location.
- // If this verification fails, whereby the CA isn't trusted,
- // dwError is set to CERT_E_UNTRUSTEDCA.
- //
- // If CERT_PROT_ROOT_DISABLE_NT_AUTH_REQUIRED_FLAG is set
- // in the "Flags" value of the HKLM policy "ProtectedRoots" subkey
- // defined by CERT_PROT_ROOT_FLAGS_REGPATH, then,
- // if the above check fails, checks if the chain
- // has CERT_TRUST_HAS_VALID_NAME_CONSTRAINTS set in dwInfoStatus. This
- // will only be set if there was a valid name constraint for all
- // name spaces including UPN. If the chain doesn't have this info
- // status set, dwError is set to CERT_E_UNTRUSTEDCA.
- //--------------------------------------------------------------------------
- //+-------------------------------------------------------------------------
- // CERT_CHAIN_POLICY_MICROSOFT_ROOT
- //
- // Checks if the last element of the first simple chain contains a
- // Microsoft root public key. If it doesn't contain a Microsoft root
- // public key, dwError is set to CERT_E_UNTRUSTEDROOT.
- //
- // pPolicyPara is optional. However,
- // MICROSOFT_ROOT_CERT_CHAIN_POLICY_ENABLE_TEST_ROOT_FLAG can be set in
- // the dwFlags in pPolicyPara to also check for the Microsoft Test Roots.
- //
- // pvExtraPolicyPara and pvExtraPolicyStatus aren't used and must be set
- // to NULL.
- //--------------------------------------------------------------------------
- #define MICROSOFT_ROOT_CERT_CHAIN_POLICY_ENABLE_TEST_ROOT_FLAG 0x00010000
- //+-------------------------------------------------------------------------
- // convert formatted string to binary
- // If cchString is 0, then pszString is NULL terminated and
- // cchString is obtained via strlen() + 1.
- // dwFlags defines string format
- // if pbBinary is NULL, *pcbBinary returns the size of required memory
- // *pdwSkip returns the character count of skipped strings, optional
- // *pdwFlags returns the actual format used in the conversion, optional
- //--------------------------------------------------------------------------
- WINCRYPT32STRINGAPI
- BOOL
- WINAPI
- CryptStringToBinaryA(
- IN LPCSTR pszString,
- IN DWORD cchString,
- IN DWORD dwFlags,
- IN BYTE *pbBinary,
- IN OUT DWORD *pcbBinary,
- OUT DWORD *pdwSkip, //OPTIONAL
- OUT DWORD *pdwFlags //OPTIONAL
- );
- //+-------------------------------------------------------------------------
- // convert formatted string to binary
- // If cchString is 0, then pszString is NULL terminated and
- // cchString is obtained via strlen() + 1.
- // dwFlags defines string format
- // if pbBinary is NULL, *pcbBinary returns the size of required memory
- // *pdwSkip returns the character count of skipped strings, optional
- // *pdwFlags returns the actual format used in the conversion, optional
- //--------------------------------------------------------------------------
- WINCRYPT32STRINGAPI
- BOOL
- WINAPI
- CryptStringToBinaryW(
- IN LPCWSTR pszString,
- IN DWORD cchString,
- IN DWORD dwFlags,
- IN BYTE *pbBinary,
- IN OUT DWORD *pcbBinary,
- OUT DWORD *pdwSkip, //OPTIONAL
- OUT DWORD *pdwFlags //OPTIONAL
- );
- #ifdef UNICODE
- #define CryptStringToBinary CryptStringToBinaryW
- #else
- #define CryptStringToBinary CryptStringToBinaryA
- #endif // !UNICODE
- //+-------------------------------------------------------------------------
- // convert binary to formatted string
- // dwFlags defines string format
- // if pszString is NULL, *pcchString returns size in characters
- // including null-terminator
- //--------------------------------------------------------------------------
- WINCRYPT32STRINGAPI
- BOOL
- WINAPI
- CryptBinaryToStringA(
- IN CONST BYTE *pbBinary,
- IN DWORD cbBinary,
- IN DWORD dwFlags,
- IN LPSTR pszString,
- IN OUT DWORD *pcchString
- );
- //+-------------------------------------------------------------------------
- // convert binary to formatted string
- // dwFlags defines string format
- // if pszString is NULL, *pcchString returns size in characters
- // including null-terminator
- //--------------------------------------------------------------------------
- WINCRYPT32STRINGAPI
- BOOL
- WINAPI
- CryptBinaryToStringW(
- IN CONST BYTE *pbBinary,
- IN DWORD cbBinary,
- IN DWORD dwFlags,
- IN LPWSTR pszString,
- IN OUT DWORD *pcchString
- );
- #ifdef UNICODE
- #define CryptBinaryToString CryptBinaryToStringW
- #else
- #define CryptBinaryToString CryptBinaryToStringA
- #endif // !UNICODE
- // dwFlags has the following defines
- #define CRYPT_STRING_BASE64HEADER 0x00000000
- #define CRYPT_STRING_BASE64 0x00000001
- #define CRYPT_STRING_BINARY 0x00000002
- #define CRYPT_STRING_BASE64REQUESTHEADER 0x00000003
- #define CRYPT_STRING_HEX 0x00000004
- #define CRYPT_STRING_HEXASCII 0x00000005
- #define CRYPT_STRING_BASE64_ANY 0x00000006
- #define CRYPT_STRING_ANY 0x00000007
- #define CRYPT_STRING_HEX_ANY 0x00000008
- #define CRYPT_STRING_BASE64X509CRLHEADER 0x00000009
- #define CRYPT_STRING_HEXADDR 0x0000000a
- #define CRYPT_STRING_HEXASCIIADDR 0x0000000b
- #define CRYPT_STRING_NOCR 0x80000000
- // CryptBinaryToString uses the following flags
- // CRYPT_STRING_BASE64HEADER - base64 format with certificate begin
- // and end headers
- // CRYPT_STRING_BASE64 - only base64 without headers
- // CRYPT_STRING_BINARY - pure binary copy
- // CRYPT_STRING_BASE64REQUESTHEADER - base64 format with request begin
- // and end headers
- // CRYPT_STRING_BASE64X509CRLHEADER - base64 format with x509 crl begin
- // and end headers
- // CRYPT_STRING_HEX - only hex format
- // CRYPT_STRING_HEXASCII - hex format with ascii char display
- // CRYPT_STRING_HEXADDR - hex format with address display
- // CRYPT_STRING_HEXASCIIADDR - hex format with ascii char and address display
- //
- // CryptBinaryToString accepts CRYPT_STRING_NOCR or'd into one of the above.
- // When set, line breaks contain only LF, instead of CR-LF pairs.
- // CryptStringToBinary uses the following flags
- // CRYPT_STRING_BASE64_ANY tries the following, in order:
- // CRYPT_STRING_BASE64HEADER
- // CRYPT_STRING_BASE64
- // CRYPT_STRING_ANY tries the following, in order:
- // CRYPT_STRING_BASE64_ANY
- // CRYPT_STRING_BINARY -- should always succeed
- // CRYPT_STRING_HEX_ANY tries the following, in order:
- // CRYPT_STRING_HEXADDR
- // CRYPT_STRING_HEXASCIIADDR
- // CRYPT_STRING_HEXASCII
- // CRYPT_STRING_HEX
- //+=========================================================================
- // PFX (PKCS #12) function defintions and types
- //==========================================================================
- //+-------------------------------------------------------------------------
- // PFXImportCertStore
- //
- // Import the PFX blob and return a store containing certificates
- //
- // If the password parameter is incorrect or any other problems decoding
- // the PFX blob are encountered, the function will return NULL and the
- // error code can be found from GetLastError().
- //
- // The dwFlags parameter may be set to the following:
- // CRYPT_EXPORTABLE - specify that any imported keys should be marked as
- // exportable (see documentation on CryptImportKey)
- // CRYPT_USER_PROTECTED - (see documentation on CryptImportKey)
- // CRYPT_MACHINE_KEYSET - used to force the private key to be stored in the
- // the local machine and not the current user.
- // CRYPT_USER_KEYSET - used to force the private key to be stored in the
- // the current user and not the local machine, even if
- // the pfx blob specifies that it should go into local
- // machine.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- HCERTSTORE
- WINAPI
- PFXImportCertStore(
- IN CRYPT_DATA_BLOB* pPFX,
- IN LPCWSTR szPassword,
- IN DWORD dwFlags);
- // dwFlags definitions for PFXImportCertStore
- //#define CRYPT_EXPORTABLE 0x00000001 // CryptImportKey dwFlags
- //#define CRYPT_USER_PROTECTED 0x00000002 // CryptImportKey dwFlags
- //#define CRYPT_MACHINE_KEYSET 0x00000020 // CryptAcquireContext dwFlags
- #define CRYPT_USER_KEYSET 0x00001000
- #define PKCS12_IMPORT_RESERVED_MASK 0xffff0000
- //+-------------------------------------------------------------------------
- // PFXIsPFXBlob
- //
- // This function will try to decode the outer layer of the blob as a pfx
- // blob, and if that works it will return TRUE, it will return FALSE otherwise
- //
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- PFXIsPFXBlob(
- IN CRYPT_DATA_BLOB* pPFX);
- //+-------------------------------------------------------------------------
- // PFXVerifyPassword
- //
- // This function will attempt to decode the outer layer of the blob as a pfx
- // blob and decrypt with the given password. No data from the blob will be
- // imported.
- //
- // Return value is TRUE if password appears correct, FALSE otherwise.
- //
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- PFXVerifyPassword(
- IN CRYPT_DATA_BLOB* pPFX,
- IN LPCWSTR szPassword,
- IN DWORD dwFlags);
- //+-------------------------------------------------------------------------
- // PFXExportCertStoreEx
- //
- // Export the certificates and private keys referenced in the passed-in store
- //
- // This API encodes the blob under a stronger algorithm. The resulting
- // PKCS12 blobs are incompatible with the earlier PFXExportCertStore API.
- //
- // The value passed in the password parameter will be used to encrypt and
- // verify the integrity of the PFX packet. If any problems encoding the store
- // are encountered, the function will return FALSE and the error code can
- // be found from GetLastError().
- //
- // The dwFlags parameter may be set to any combination of
- // EXPORT_PRIVATE_KEYS
- // REPORT_NO_PRIVATE_KEY
- // REPORT_NOT_ABLE_TO_EXPORT_PRIVATE_KEY
- //
- // The encoded PFX blob is returned in *pPFX. If pPFX->pbData is NULL upon
- // input, this is a length only calculation, whereby, pPFX->cbData is updated
- // with the number of bytes required for the encoded blob. Otherwise,
- // the memory pointed to by pPFX->pbData is updated with the encoded bytes
- // and pPFX->cbData is updated with the encoded byte length.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- PFXExportCertStoreEx(
- IN HCERTSTORE hStore,
- IN OUT CRYPT_DATA_BLOB* pPFX,
- IN LPCWSTR szPassword,
- IN void* pvReserved,
- IN DWORD dwFlags);
- // dwFlags definitions for PFXExportCertStoreEx
- #define REPORT_NO_PRIVATE_KEY 0x0001
- #define REPORT_NOT_ABLE_TO_EXPORT_PRIVATE_KEY 0x0002
- #define EXPORT_PRIVATE_KEYS 0x0004
- #define PKCS12_EXPORT_RESERVED_MASK 0xffff0000
- //+-------------------------------------------------------------------------
- // PFXExportCertStore
- //
- // Export the certificates and private keys referenced in the passed-in store
- //
- // This is an old API kept for compatibility with IE4 clients. New applications
- // should call the above PfxExportCertStoreEx for enhanced security.
- //--------------------------------------------------------------------------
- WINCRYPT32API
- BOOL
- WINAPI
- PFXExportCertStore(
- IN HCERTSTORE hStore,
- IN OUT CRYPT_DATA_BLOB* pPFX,
- IN LPCWSTR szPassword,
- IN DWORD dwFlags);
- #ifdef __cplusplus
- } // Balance extern "C" above
- #endif
- #if defined (_MSC_VER)
- #if ( _MSC_VER >= 800 )
- #if _MSC_VER >= 1200
- #pragma warning(pop)
- #else
- #pragma warning(default:4201)
- #endif
- #endif
- #endif
- #endif // __WINCRYPT_H__
|