Win32 API 日本語リファレンス
ホームSecurity.Cryptography › CertSetEnhancedKeyUsage

CertSetEnhancedKeyUsage

関数
証明書の拡張キー使用法(EKU)を設定する。
DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// CRYPT32.dll
#include <windows.h>

BOOL CertSetEnhancedKeyUsage(
    const CERT_CONTEXT* pCertContext,
    CTL_USAGE* pUsage   // optional
);

パラメーター

名前方向説明
pCertContextCERT_CONTEXT*in指定した証明書の CERT_CONTEXT へのポインター。
pUsageCTL_USAGE*inoptional証明書の拡張プロパティとして設定する EKU オブジェクト識別子 (OID) の配列を含む CERT_ENHKEY_USAGE 構造体 ( CTL_USAGE 構造体と同等) へのポインター。

戻り値の型: BOOL

公式ドキュメント

CertSetEnhancedKeyUsage 関数は、証明書に拡張キー使用法 (EKU) プロパティを設定します。

戻り値

関数が成功した場合、関数は 0 以外 (TRUE) を返します。

関数が失敗した場合は 0 (FALSE) を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// CRYPT32.dll
#include <windows.h>

BOOL CertSetEnhancedKeyUsage(
    const CERT_CONTEXT* pCertContext,
    CTL_USAGE* pUsage   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertSetEnhancedKeyUsage(
    IntPtr pCertContext,   // CERT_CONTEXT*
    IntPtr pUsage   // CTL_USAGE* optional
);
<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertSetEnhancedKeyUsage(
    pCertContext As IntPtr,   ' CERT_CONTEXT*
    pUsage As IntPtr   ' CTL_USAGE* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pCertContext : CERT_CONTEXT*
' pUsage : CTL_USAGE* optional
Declare PtrSafe Function CertSetEnhancedKeyUsage Lib "crypt32" ( _
    ByVal pCertContext As LongPtr, _
    ByVal pUsage As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CertSetEnhancedKeyUsage = ctypes.windll.crypt32.CertSetEnhancedKeyUsage
CertSetEnhancedKeyUsage.restype = wintypes.BOOL
CertSetEnhancedKeyUsage.argtypes = [
    ctypes.c_void_p,  # pCertContext : CERT_CONTEXT*
    ctypes.c_void_p,  # pUsage : CTL_USAGE* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertSetEnhancedKeyUsage = Fiddle::Function.new(
  lib['CertSetEnhancedKeyUsage'],
  [
    Fiddle::TYPE_VOIDP,  # pCertContext : CERT_CONTEXT*
    Fiddle::TYPE_VOIDP,  # pUsage : CTL_USAGE* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "crypt32")]
extern "system" {
    fn CertSetEnhancedKeyUsage(
        pCertContext: *const CERT_CONTEXT,  // CERT_CONTEXT*
        pUsage: *mut CTL_USAGE  // CTL_USAGE* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CertSetEnhancedKeyUsage(IntPtr pCertContext, IntPtr pUsage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertSetEnhancedKeyUsage' -Namespace Win32 -PassThru
# $api::CertSetEnhancedKeyUsage(pCertContext, pUsage)
#uselib "CRYPT32.dll"
#func global CertSetEnhancedKeyUsage "CertSetEnhancedKeyUsage" sptr, sptr
; CertSetEnhancedKeyUsage varptr(pCertContext), varptr(pUsage)   ; 戻り値は stat
; pCertContext : CERT_CONTEXT* -> "sptr"
; pUsage : CTL_USAGE* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CRYPT32.dll"
#cfunc global CertSetEnhancedKeyUsage "CertSetEnhancedKeyUsage" var, var
; res = CertSetEnhancedKeyUsage(pCertContext, pUsage)
; pCertContext : CERT_CONTEXT* -> "var"
; pUsage : CTL_USAGE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CertSetEnhancedKeyUsage(CERT_CONTEXT* pCertContext, CTL_USAGE* pUsage)
#uselib "CRYPT32.dll"
#cfunc global CertSetEnhancedKeyUsage "CertSetEnhancedKeyUsage" var, var
; res = CertSetEnhancedKeyUsage(pCertContext, pUsage)
; pCertContext : CERT_CONTEXT* -> "var"
; pUsage : CTL_USAGE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
	procCertSetEnhancedKeyUsage = crypt32.NewProc("CertSetEnhancedKeyUsage")
)

// pCertContext (CERT_CONTEXT*), pUsage (CTL_USAGE* optional)
r1, _, err := procCertSetEnhancedKeyUsage.Call(
	uintptr(pCertContext),
	uintptr(pUsage),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CertSetEnhancedKeyUsage(
  pCertContext: Pointer;   // CERT_CONTEXT*
  pUsage: Pointer   // CTL_USAGE* optional
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CertSetEnhancedKeyUsage';
result := DllCall("CRYPT32\CertSetEnhancedKeyUsage"
    , "Ptr", pCertContext   ; CERT_CONTEXT*
    , "Ptr", pUsage   ; CTL_USAGE* optional
    , "Int")   ; return: BOOL
●CertSetEnhancedKeyUsage(pCertContext, pUsage) = DLL("CRYPT32.dll", "bool CertSetEnhancedKeyUsage(void*, void*)")
# 呼び出し: CertSetEnhancedKeyUsage(pCertContext, pUsage)
# pCertContext : CERT_CONTEXT* -> "void*"
# pUsage : CTL_USAGE* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "crypt32" fn CertSetEnhancedKeyUsage(
    pCertContext: [*c]CERT_CONTEXT, // CERT_CONTEXT*
    pUsage: [*c]CTL_USAGE // CTL_USAGE* optional
) callconv(std.os.windows.WINAPI) i32;
proc CertSetEnhancedKeyUsage(
    pCertContext: ptr CERT_CONTEXT,  # CERT_CONTEXT*
    pUsage: ptr CTL_USAGE  # CTL_USAGE* optional
): int32 {.importc: "CertSetEnhancedKeyUsage", stdcall, dynlib: "CRYPT32.dll".}
pragma(lib, "crypt32");
extern(Windows)
int CertSetEnhancedKeyUsage(
    CERT_CONTEXT* pCertContext,   // CERT_CONTEXT*
    CTL_USAGE* pUsage   // CTL_USAGE* optional
);
ccall((:CertSetEnhancedKeyUsage, "CRYPT32.dll"), stdcall, Int32,
      (Ptr{CERT_CONTEXT}, Ptr{CTL_USAGE}),
      pCertContext, pUsage)
# pCertContext : CERT_CONTEXT* -> Ptr{CERT_CONTEXT}
# pUsage : CTL_USAGE* optional -> Ptr{CTL_USAGE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CertSetEnhancedKeyUsage(
    void* pCertContext,
    void* pUsage);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CertSetEnhancedKeyUsage(pCertContext, pUsage)
-- pCertContext : CERT_CONTEXT*
-- pUsage : CTL_USAGE* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CertSetEnhancedKeyUsage = lib.func('__stdcall', 'CertSetEnhancedKeyUsage', 'int32_t', ['void *', 'void *']);
// CertSetEnhancedKeyUsage(pCertContext, pUsage)
// pCertContext : CERT_CONTEXT* -> 'void *'
// pUsage : CTL_USAGE* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CRYPT32.dll", {
  CertSetEnhancedKeyUsage: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.CertSetEnhancedKeyUsage(pCertContext, pUsage)
// pCertContext : CERT_CONTEXT* -> "pointer"
// pUsage : CTL_USAGE* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CertSetEnhancedKeyUsage(
    void* pCertContext,
    void* pUsage);
C, "CRYPT32.dll");
// $ffi->CertSetEnhancedKeyUsage(pCertContext, pUsage);
// pCertContext : CERT_CONTEXT*
// pUsage : CTL_USAGE* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Crypt32 extends StdCallLibrary {
    Crypt32 INSTANCE = Native.load("crypt32", Crypt32.class);
    boolean CertSetEnhancedKeyUsage(
        Pointer pCertContext,   // CERT_CONTEXT*
        Pointer pUsage   // CTL_USAGE* optional
    );
}
@[Link("crypt32")]
lib LibCRYPT32
  fun CertSetEnhancedKeyUsage = CertSetEnhancedKeyUsage(
    pCertContext : CERT_CONTEXT*,   # CERT_CONTEXT*
    pUsage : CTL_USAGE*   # CTL_USAGE* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CertSetEnhancedKeyUsageNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef CertSetEnhancedKeyUsageDart = int Function(Pointer<Void>, Pointer<Void>);
final CertSetEnhancedKeyUsage = DynamicLibrary.open('CRYPT32.dll')
    .lookupFunction<CertSetEnhancedKeyUsageNative, CertSetEnhancedKeyUsageDart>('CertSetEnhancedKeyUsage');
// pCertContext : CERT_CONTEXT* -> Pointer<Void>
// pUsage : CTL_USAGE* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CertSetEnhancedKeyUsage(
  pCertContext: Pointer;   // CERT_CONTEXT*
  pUsage: Pointer   // CTL_USAGE* optional
): BOOL; stdcall;
  external 'CRYPT32.dll' name 'CertSetEnhancedKeyUsage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CertSetEnhancedKeyUsage"
  c_CertSetEnhancedKeyUsage :: Ptr () -> Ptr () -> IO CInt
-- pCertContext : CERT_CONTEXT* -> Ptr ()
-- pUsage : CTL_USAGE* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let certsetenhancedkeyusage =
  foreign "CertSetEnhancedKeyUsage"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* pCertContext : CERT_CONTEXT* -> (ptr void) *)
(* pUsage : CTL_USAGE* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)

(cffi:defcfun ("CertSetEnhancedKeyUsage" cert-set-enhanced-key-usage :convention :stdcall) :int32
  (p-cert-context :pointer)   ; CERT_CONTEXT*
  (p-usage :pointer))   ; CTL_USAGE* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CertSetEnhancedKeyUsage = Win32::API::More->new('CRYPT32',
    'BOOL CertSetEnhancedKeyUsage(LPVOID pCertContext, LPVOID pUsage)');
# my $ret = $CertSetEnhancedKeyUsage->Call($pCertContext, $pUsage);
# pCertContext : CERT_CONTEXT* -> LPVOID
# pUsage : CTL_USAGE* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型