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

SslEnumCipherSuites

関数
SSLプロバイダーがサポートする暗号スイートを列挙する。
DLLncrypt.dll呼出規約winapi

シグネチャ

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

HRESULT SslEnumCipherSuites(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hPrivateKey,   // optional
    NCRYPT_SSL_CIPHER_SUITE** ppCipherSuite,
    void** ppEnumState,
    DWORD dwFlags
);

パラメーター

名前方向説明
hSslProviderNCRYPT_PROV_HANDLEinSchannel SSLプロバイダのハンドル。
hPrivateKeyNCRYPT_KEY_HANDLEinoptional対象とする秘密鍵のハンドル。NULL可。
ppCipherSuiteNCRYPT_SSL_CIPHER_SUITE**out列挙された暗号スイート情報NCRYPT_SSL_CIPHER_SUITEを受け取る出力先。
ppEnumStatevoid**inout列挙状態を保持するポインタ。初回はNULLを指す変数を渡す。
dwFlagsDWORDin動作を制御するフラグ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SslEnumCipherSuites(
    NCRYPT_PROV_HANDLE hSslProvider,
    NCRYPT_KEY_HANDLE hPrivateKey,   // optional
    NCRYPT_SSL_CIPHER_SUITE** ppCipherSuite,
    void** ppEnumState,
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int SslEnumCipherSuites(
    UIntPtr hSslProvider,   // NCRYPT_PROV_HANDLE
    UIntPtr hPrivateKey,   // NCRYPT_KEY_HANDLE optional
    IntPtr ppCipherSuite,   // NCRYPT_SSL_CIPHER_SUITE** out
    IntPtr ppEnumState,   // void** in/out
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function SslEnumCipherSuites(
    hSslProvider As UIntPtr,   ' NCRYPT_PROV_HANDLE
    hPrivateKey As UIntPtr,   ' NCRYPT_KEY_HANDLE optional
    ppCipherSuite As IntPtr,   ' NCRYPT_SSL_CIPHER_SUITE** out
    ppEnumState As IntPtr,   ' void** in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' hSslProvider : NCRYPT_PROV_HANDLE
' hPrivateKey : NCRYPT_KEY_HANDLE optional
' ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out
' ppEnumState : void** in/out
' dwFlags : DWORD
Declare PtrSafe Function SslEnumCipherSuites Lib "ncrypt" ( _
    ByVal hSslProvider As LongPtr, _
    ByVal hPrivateKey As LongPtr, _
    ByVal ppCipherSuite As LongPtr, _
    ByVal ppEnumState As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SslEnumCipherSuites = ctypes.windll.ncrypt.SslEnumCipherSuites
SslEnumCipherSuites.restype = ctypes.c_int
SslEnumCipherSuites.argtypes = [
    ctypes.c_size_t,  # hSslProvider : NCRYPT_PROV_HANDLE
    ctypes.c_size_t,  # hPrivateKey : NCRYPT_KEY_HANDLE optional
    ctypes.c_void_p,  # ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out
    ctypes.c_void_p,  # ppEnumState : void** in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
SslEnumCipherSuites = Fiddle::Function.new(
  lib['SslEnumCipherSuites'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hSslProvider : NCRYPT_PROV_HANDLE
    Fiddle::TYPE_UINTPTR_T,  # hPrivateKey : NCRYPT_KEY_HANDLE optional
    Fiddle::TYPE_VOIDP,  # ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out
    Fiddle::TYPE_VOIDP,  # ppEnumState : void** in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "ncrypt")]
extern "system" {
    fn SslEnumCipherSuites(
        hSslProvider: usize,  // NCRYPT_PROV_HANDLE
        hPrivateKey: usize,  // NCRYPT_KEY_HANDLE optional
        ppCipherSuite: *mut *mut NCRYPT_SSL_CIPHER_SUITE,  // NCRYPT_SSL_CIPHER_SUITE** out
        ppEnumState: *mut *mut (),  // void** in/out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ncrypt.dll")]
public static extern int SslEnumCipherSuites(UIntPtr hSslProvider, UIntPtr hPrivateKey, IntPtr ppCipherSuite, IntPtr ppEnumState, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_SslEnumCipherSuites' -Namespace Win32 -PassThru
# $api::SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
#uselib "ncrypt.dll"
#func global SslEnumCipherSuites "SslEnumCipherSuites" sptr, sptr, sptr, sptr, sptr
; SslEnumCipherSuites hSslProvider, hPrivateKey, varptr(ppCipherSuite), ppEnumState, dwFlags   ; 戻り値は stat
; hSslProvider : NCRYPT_PROV_HANDLE -> "sptr"
; hPrivateKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> "sptr"
; ppEnumState : void** in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ncrypt.dll"
#cfunc global SslEnumCipherSuites "SslEnumCipherSuites" sptr, sptr, var, sptr, int
; res = SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
; hSslProvider : NCRYPT_PROV_HANDLE -> "sptr"
; hPrivateKey : NCRYPT_KEY_HANDLE optional -> "sptr"
; ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> "var"
; ppEnumState : void** in/out -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SslEnumCipherSuites(NCRYPT_PROV_HANDLE hSslProvider, NCRYPT_KEY_HANDLE hPrivateKey, NCRYPT_SSL_CIPHER_SUITE** ppCipherSuite, void** ppEnumState, DWORD dwFlags)
#uselib "ncrypt.dll"
#cfunc global SslEnumCipherSuites "SslEnumCipherSuites" intptr, intptr, var, intptr, int
; res = SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
; hSslProvider : NCRYPT_PROV_HANDLE -> "intptr"
; hPrivateKey : NCRYPT_KEY_HANDLE optional -> "intptr"
; ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> "var"
; ppEnumState : void** in/out -> "intptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procSslEnumCipherSuites = ncrypt.NewProc("SslEnumCipherSuites")
)

// hSslProvider (NCRYPT_PROV_HANDLE), hPrivateKey (NCRYPT_KEY_HANDLE optional), ppCipherSuite (NCRYPT_SSL_CIPHER_SUITE** out), ppEnumState (void** in/out), dwFlags (DWORD)
r1, _, err := procSslEnumCipherSuites.Call(
	uintptr(hSslProvider),
	uintptr(hPrivateKey),
	uintptr(ppCipherSuite),
	uintptr(ppEnumState),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SslEnumCipherSuites(
  hSslProvider: NativeUInt;   // NCRYPT_PROV_HANDLE
  hPrivateKey: NativeUInt;   // NCRYPT_KEY_HANDLE optional
  ppCipherSuite: Pointer;   // NCRYPT_SSL_CIPHER_SUITE** out
  ppEnumState: Pointer;   // void** in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'SslEnumCipherSuites';
result := DllCall("ncrypt\SslEnumCipherSuites"
    , "UPtr", hSslProvider   ; NCRYPT_PROV_HANDLE
    , "UPtr", hPrivateKey   ; NCRYPT_KEY_HANDLE optional
    , "Ptr", ppCipherSuite   ; NCRYPT_SSL_CIPHER_SUITE** out
    , "Ptr", ppEnumState   ; void** in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags) = DLL("ncrypt.dll", "int SslEnumCipherSuites(int, int, void*, void*, dword)")
# 呼び出し: SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
# hSslProvider : NCRYPT_PROV_HANDLE -> "int"
# hPrivateKey : NCRYPT_KEY_HANDLE optional -> "int"
# ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> "void*"
# ppEnumState : void** in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ncrypt" fn SslEnumCipherSuites(
    hSslProvider: usize, // NCRYPT_PROV_HANDLE
    hPrivateKey: usize, // NCRYPT_KEY_HANDLE optional
    ppCipherSuite: [*c][*c]NCRYPT_SSL_CIPHER_SUITE, // NCRYPT_SSL_CIPHER_SUITE** out
    ppEnumState: ?*anyopaque, // void** in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SslEnumCipherSuites(
    hSslProvider: uint,  # NCRYPT_PROV_HANDLE
    hPrivateKey: uint,  # NCRYPT_KEY_HANDLE optional
    ppCipherSuite: ptr NCRYPT_SSL_CIPHER_SUITE,  # NCRYPT_SSL_CIPHER_SUITE** out
    ppEnumState: pointer,  # void** in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "SslEnumCipherSuites", stdcall, dynlib: "ncrypt.dll".}
pragma(lib, "ncrypt");
extern(Windows)
int SslEnumCipherSuites(
    size_t hSslProvider,   // NCRYPT_PROV_HANDLE
    size_t hPrivateKey,   // NCRYPT_KEY_HANDLE optional
    NCRYPT_SSL_CIPHER_SUITE** ppCipherSuite,   // NCRYPT_SSL_CIPHER_SUITE** out
    void** ppEnumState,   // void** in/out
    uint dwFlags   // DWORD
);
ccall((:SslEnumCipherSuites, "ncrypt.dll"), stdcall, Int32,
      (Csize_t, Csize_t, Ptr{NCRYPT_SSL_CIPHER_SUITE}, Ptr{Cvoid}, UInt32),
      hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
# hSslProvider : NCRYPT_PROV_HANDLE -> Csize_t
# hPrivateKey : NCRYPT_KEY_HANDLE optional -> Csize_t
# ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> Ptr{NCRYPT_SSL_CIPHER_SUITE}
# ppEnumState : void** in/out -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SslEnumCipherSuites(
    uintptr_t hSslProvider,
    uintptr_t hPrivateKey,
    void* ppCipherSuite,
    void** ppEnumState,
    uint32_t dwFlags);
]]
local ncrypt = ffi.load("ncrypt")
-- ncrypt.SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
-- hSslProvider : NCRYPT_PROV_HANDLE
-- hPrivateKey : NCRYPT_KEY_HANDLE optional
-- ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out
-- ppEnumState : void** in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ncrypt.dll');
const SslEnumCipherSuites = lib.func('__stdcall', 'SslEnumCipherSuites', 'int32_t', ['uintptr_t', 'uintptr_t', 'void *', 'void *', 'uint32_t']);
// SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
// hSslProvider : NCRYPT_PROV_HANDLE -> 'uintptr_t'
// hPrivateKey : NCRYPT_KEY_HANDLE optional -> 'uintptr_t'
// ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> 'void *'
// ppEnumState : void** in/out -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ncrypt.dll", {
  SslEnumCipherSuites: { parameters: ["usize", "usize", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags)
// hSslProvider : NCRYPT_PROV_HANDLE -> "usize"
// hPrivateKey : NCRYPT_KEY_HANDLE optional -> "usize"
// ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> "pointer"
// ppEnumState : void** in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SslEnumCipherSuites(
    size_t hSslProvider,
    size_t hPrivateKey,
    void* ppCipherSuite,
    void** ppEnumState,
    uint32_t dwFlags);
C, "ncrypt.dll");
// $ffi->SslEnumCipherSuites(hSslProvider, hPrivateKey, ppCipherSuite, ppEnumState, dwFlags);
// hSslProvider : NCRYPT_PROV_HANDLE
// hPrivateKey : NCRYPT_KEY_HANDLE optional
// ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out
// ppEnumState : void** in/out
// dwFlags : DWORD
// 構造体/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 Ncrypt extends StdCallLibrary {
    Ncrypt INSTANCE = Native.load("ncrypt", Ncrypt.class);
    int SslEnumCipherSuites(
        long hSslProvider,   // NCRYPT_PROV_HANDLE
        long hPrivateKey,   // NCRYPT_KEY_HANDLE optional
        Pointer ppCipherSuite,   // NCRYPT_SSL_CIPHER_SUITE** out
        Pointer ppEnumState,   // void** in/out
        int dwFlags   // DWORD
    );
}
@[Link("ncrypt")]
lib Libncrypt
  fun SslEnumCipherSuites = SslEnumCipherSuites(
    hSslProvider : LibC::SizeT,   # NCRYPT_PROV_HANDLE
    hPrivateKey : LibC::SizeT,   # NCRYPT_KEY_HANDLE optional
    ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE**,   # NCRYPT_SSL_CIPHER_SUITE** out
    ppEnumState : Void**,   # void** in/out
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SslEnumCipherSuitesNative = Int32 Function(UintPtr, UintPtr, Pointer<Void>, Pointer<Void>, Uint32);
typedef SslEnumCipherSuitesDart = int Function(int, int, Pointer<Void>, Pointer<Void>, int);
final SslEnumCipherSuites = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<SslEnumCipherSuitesNative, SslEnumCipherSuitesDart>('SslEnumCipherSuites');
// hSslProvider : NCRYPT_PROV_HANDLE -> UintPtr
// hPrivateKey : NCRYPT_KEY_HANDLE optional -> UintPtr
// ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> Pointer<Void>
// ppEnumState : void** in/out -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SslEnumCipherSuites(
  hSslProvider: NativeUInt;   // NCRYPT_PROV_HANDLE
  hPrivateKey: NativeUInt;   // NCRYPT_KEY_HANDLE optional
  ppCipherSuite: Pointer;   // NCRYPT_SSL_CIPHER_SUITE** out
  ppEnumState: Pointer;   // void** in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'SslEnumCipherSuites';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SslEnumCipherSuites"
  c_SslEnumCipherSuites :: CUIntPtr -> CUIntPtr -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- hSslProvider : NCRYPT_PROV_HANDLE -> CUIntPtr
-- hPrivateKey : NCRYPT_KEY_HANDLE optional -> CUIntPtr
-- ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> Ptr ()
-- ppEnumState : void** in/out -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sslenumciphersuites =
  foreign "SslEnumCipherSuites"
    (size_t @-> size_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hSslProvider : NCRYPT_PROV_HANDLE -> size_t *)
(* hPrivateKey : NCRYPT_KEY_HANDLE optional -> size_t *)
(* ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> (ptr void) *)
(* ppEnumState : void** in/out -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("SslEnumCipherSuites" ssl-enum-cipher-suites :convention :stdcall) :int32
  (h-ssl-provider :uint64)   ; NCRYPT_PROV_HANDLE
  (h-private-key :uint64)   ; NCRYPT_KEY_HANDLE optional
  (pp-cipher-suite :pointer)   ; NCRYPT_SSL_CIPHER_SUITE** out
  (pp-enum-state :pointer)   ; void** in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SslEnumCipherSuites = Win32::API::More->new('ncrypt',
    'int SslEnumCipherSuites(WPARAM hSslProvider, WPARAM hPrivateKey, LPVOID ppCipherSuite, LPVOID ppEnumState, DWORD dwFlags)');
# my $ret = $SslEnumCipherSuites->Call($hSslProvider, $hPrivateKey, $ppCipherSuite, $ppEnumState, $dwFlags);
# hSslProvider : NCRYPT_PROV_HANDLE -> WPARAM
# hPrivateKey : NCRYPT_KEY_HANDLE optional -> WPARAM
# ppCipherSuite : NCRYPT_SSL_CIPHER_SUITE** out -> LPVOID
# ppEnumState : void** in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型