Win32 API 日本語リファレンス
ホームSecurity.Authentication.Identity › SslGetServerIdentity

SslGetServerIdentity

関数
TLSのClientHelloからサーバー識別情報(SNI)を取得する。
DLLSCHANNEL.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT SslGetServerIdentity(
    BYTE* ClientHello,
    DWORD ClientHelloSize,
    BYTE** ServerIdentity,
    DWORD* ServerIdentitySize,
    DWORD Flags
);

パラメーター

名前方向説明
ClientHelloBYTE*in解析対象のTLS ClientHelloメッセージのバイト列へのポインタ。
ClientHelloSizeDWORDinClientHelloが指すデータのバイト長。
ServerIdentityBYTE**out抽出したサーバー識別子(SNI等)へのポインタを受け取る出力。ClientHello内を指す。
ServerIdentitySizeDWORD*outServerIdentityのバイト長を受け取るDWORDへのポインタ。
FlagsDWORDin動作を制御するフラグ。予約済みで通常は0を指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT SslGetServerIdentity(
    BYTE* ClientHello,
    DWORD ClientHelloSize,
    BYTE** ServerIdentity,
    DWORD* ServerIdentitySize,
    DWORD Flags
);
[DllImport("SCHANNEL.dll", ExactSpelling = true)]
static extern int SslGetServerIdentity(
    IntPtr ClientHello,   // BYTE*
    uint ClientHelloSize,   // DWORD
    IntPtr ServerIdentity,   // BYTE** out
    out uint ServerIdentitySize,   // DWORD* out
    uint Flags   // DWORD
);
<DllImport("SCHANNEL.dll", ExactSpelling:=True)>
Public Shared Function SslGetServerIdentity(
    ClientHello As IntPtr,   ' BYTE*
    ClientHelloSize As UInteger,   ' DWORD
    ServerIdentity As IntPtr,   ' BYTE** out
    <Out> ByRef ServerIdentitySize As UInteger,   ' DWORD* out
    Flags As UInteger   ' DWORD
) As Integer
End Function
' ClientHello : BYTE*
' ClientHelloSize : DWORD
' ServerIdentity : BYTE** out
' ServerIdentitySize : DWORD* out
' Flags : DWORD
Declare PtrSafe Function SslGetServerIdentity Lib "schannel" ( _
    ByVal ClientHello As LongPtr, _
    ByVal ClientHelloSize As Long, _
    ByVal ServerIdentity As LongPtr, _
    ByRef ServerIdentitySize As Long, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SslGetServerIdentity = ctypes.windll.schannel.SslGetServerIdentity
SslGetServerIdentity.restype = ctypes.c_int
SslGetServerIdentity.argtypes = [
    ctypes.POINTER(ctypes.c_ubyte),  # ClientHello : BYTE*
    wintypes.DWORD,  # ClientHelloSize : DWORD
    ctypes.c_void_p,  # ServerIdentity : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # ServerIdentitySize : DWORD* out
    wintypes.DWORD,  # Flags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	schannel = windows.NewLazySystemDLL("SCHANNEL.dll")
	procSslGetServerIdentity = schannel.NewProc("SslGetServerIdentity")
)

// ClientHello (BYTE*), ClientHelloSize (DWORD), ServerIdentity (BYTE** out), ServerIdentitySize (DWORD* out), Flags (DWORD)
r1, _, err := procSslGetServerIdentity.Call(
	uintptr(ClientHello),
	uintptr(ClientHelloSize),
	uintptr(ServerIdentity),
	uintptr(ServerIdentitySize),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SslGetServerIdentity(
  ClientHello: Pointer;   // BYTE*
  ClientHelloSize: DWORD;   // DWORD
  ServerIdentity: Pointer;   // BYTE** out
  ServerIdentitySize: Pointer;   // DWORD* out
  Flags: DWORD   // DWORD
): Integer; stdcall;
  external 'SCHANNEL.dll' name 'SslGetServerIdentity';
result := DllCall("SCHANNEL\SslGetServerIdentity"
    , "Ptr", ClientHello   ; BYTE*
    , "UInt", ClientHelloSize   ; DWORD
    , "Ptr", ServerIdentity   ; BYTE** out
    , "Ptr", ServerIdentitySize   ; DWORD* out
    , "UInt", Flags   ; DWORD
    , "Int")   ; return: HRESULT
●SslGetServerIdentity(ClientHello, ClientHelloSize, ServerIdentity, ServerIdentitySize, Flags) = DLL("SCHANNEL.dll", "int SslGetServerIdentity(void*, dword, void*, void*, dword)")
# 呼び出し: SslGetServerIdentity(ClientHello, ClientHelloSize, ServerIdentity, ServerIdentitySize, Flags)
# ClientHello : BYTE* -> "void*"
# ClientHelloSize : DWORD -> "dword"
# ServerIdentity : BYTE** out -> "void*"
# ServerIdentitySize : DWORD* out -> "void*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "schannel" fn SslGetServerIdentity(
    ClientHello: [*c]u8, // BYTE*
    ClientHelloSize: u32, // DWORD
    ServerIdentity: [*c][*c]u8, // BYTE** out
    ServerIdentitySize: [*c]u32, // DWORD* out
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SslGetServerIdentity(
    ClientHello: ptr uint8,  # BYTE*
    ClientHelloSize: uint32,  # DWORD
    ServerIdentity: ptr uint8,  # BYTE** out
    ServerIdentitySize: ptr uint32,  # DWORD* out
    Flags: uint32  # DWORD
): int32 {.importc: "SslGetServerIdentity", stdcall, dynlib: "SCHANNEL.dll".}
pragma(lib, "schannel");
extern(Windows)
int SslGetServerIdentity(
    ubyte* ClientHello,   // BYTE*
    uint ClientHelloSize,   // DWORD
    ubyte** ServerIdentity,   // BYTE** out
    uint* ServerIdentitySize,   // DWORD* out
    uint Flags   // DWORD
);
ccall((:SslGetServerIdentity, "SCHANNEL.dll"), stdcall, Int32,
      (Ptr{UInt8}, UInt32, Ptr{UInt8}, Ptr{UInt32}, UInt32),
      ClientHello, ClientHelloSize, ServerIdentity, ServerIdentitySize, Flags)
# ClientHello : BYTE* -> Ptr{UInt8}
# ClientHelloSize : DWORD -> UInt32
# ServerIdentity : BYTE** out -> Ptr{UInt8}
# ServerIdentitySize : DWORD* out -> Ptr{UInt32}
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SslGetServerIdentity(
    uint8_t* ClientHello,
    uint32_t ClientHelloSize,
    uint8_t** ServerIdentity,
    uint32_t* ServerIdentitySize,
    uint32_t Flags);
]]
local schannel = ffi.load("schannel")
-- schannel.SslGetServerIdentity(ClientHello, ClientHelloSize, ServerIdentity, ServerIdentitySize, Flags)
-- ClientHello : BYTE*
-- ClientHelloSize : DWORD
-- ServerIdentity : BYTE** out
-- ServerIdentitySize : DWORD* out
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SCHANNEL.dll');
const SslGetServerIdentity = lib.func('__stdcall', 'SslGetServerIdentity', 'int32_t', ['uint8_t *', 'uint32_t', 'uint8_t *', 'uint32_t *', 'uint32_t']);
// SslGetServerIdentity(ClientHello, ClientHelloSize, ServerIdentity, ServerIdentitySize, Flags)
// ClientHello : BYTE* -> 'uint8_t *'
// ClientHelloSize : DWORD -> 'uint32_t'
// ServerIdentity : BYTE** out -> 'uint8_t *'
// ServerIdentitySize : DWORD* out -> 'uint32_t *'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SCHANNEL.dll", {
  SslGetServerIdentity: { parameters: ["pointer", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SslGetServerIdentity(ClientHello, ClientHelloSize, ServerIdentity, ServerIdentitySize, Flags)
// ClientHello : BYTE* -> "pointer"
// ClientHelloSize : DWORD -> "u32"
// ServerIdentity : BYTE** out -> "pointer"
// ServerIdentitySize : DWORD* out -> "pointer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SslGetServerIdentity(
    uint8_t* ClientHello,
    uint32_t ClientHelloSize,
    uint8_t** ServerIdentity,
    uint32_t* ServerIdentitySize,
    uint32_t Flags);
C, "SCHANNEL.dll");
// $ffi->SslGetServerIdentity(ClientHello, ClientHelloSize, ServerIdentity, ServerIdentitySize, Flags);
// ClientHello : BYTE*
// ClientHelloSize : DWORD
// ServerIdentity : BYTE** out
// ServerIdentitySize : DWORD* out
// Flags : 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 Schannel extends StdCallLibrary {
    Schannel INSTANCE = Native.load("schannel", Schannel.class);
    int SslGetServerIdentity(
        byte[] ClientHello,   // BYTE*
        int ClientHelloSize,   // DWORD
        Pointer ServerIdentity,   // BYTE** out
        IntByReference ServerIdentitySize,   // DWORD* out
        int Flags   // DWORD
    );
}
@[Link("schannel")]
lib LibSCHANNEL
  fun SslGetServerIdentity = SslGetServerIdentity(
    ClientHello : UInt8*,   # BYTE*
    ClientHelloSize : UInt32,   # DWORD
    ServerIdentity : UInt8**,   # BYTE** out
    ServerIdentitySize : UInt32*,   # DWORD* out
    Flags : 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 SslGetServerIdentityNative = Int32 Function(Pointer<Uint8>, Uint32, Pointer<Uint8>, Pointer<Uint32>, Uint32);
typedef SslGetServerIdentityDart = int Function(Pointer<Uint8>, int, Pointer<Uint8>, Pointer<Uint32>, int);
final SslGetServerIdentity = DynamicLibrary.open('SCHANNEL.dll')
    .lookupFunction<SslGetServerIdentityNative, SslGetServerIdentityDart>('SslGetServerIdentity');
// ClientHello : BYTE* -> Pointer<Uint8>
// ClientHelloSize : DWORD -> Uint32
// ServerIdentity : BYTE** out -> Pointer<Uint8>
// ServerIdentitySize : DWORD* out -> Pointer<Uint32>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SslGetServerIdentity(
  ClientHello: Pointer;   // BYTE*
  ClientHelloSize: DWORD;   // DWORD
  ServerIdentity: Pointer;   // BYTE** out
  ServerIdentitySize: Pointer;   // DWORD* out
  Flags: DWORD   // DWORD
): Integer; stdcall;
  external 'SCHANNEL.dll' name 'SslGetServerIdentity';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SslGetServerIdentity"
  c_SslGetServerIdentity :: Ptr Word8 -> Word32 -> Ptr Word8 -> Ptr Word32 -> Word32 -> IO Int32
-- ClientHello : BYTE* -> Ptr Word8
-- ClientHelloSize : DWORD -> Word32
-- ServerIdentity : BYTE** out -> Ptr Word8
-- ServerIdentitySize : DWORD* out -> Ptr Word32
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sslgetserveridentity =
  foreign "SslGetServerIdentity"
    ((ptr uint8_t) @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* ClientHello : BYTE* -> (ptr uint8_t) *)
(* ClientHelloSize : DWORD -> uint32_t *)
(* ServerIdentity : BYTE** out -> (ptr uint8_t) *)
(* ServerIdentitySize : DWORD* out -> (ptr uint32_t) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library schannel (t "SCHANNEL.dll"))
(cffi:use-foreign-library schannel)

(cffi:defcfun ("SslGetServerIdentity" ssl-get-server-identity :convention :stdcall) :int32
  (client-hello :pointer)   ; BYTE*
  (client-hello-size :uint32)   ; DWORD
  (server-identity :pointer)   ; BYTE** out
  (server-identity-size :pointer)   ; DWORD* out
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SslGetServerIdentity = Win32::API::More->new('SCHANNEL',
    'int SslGetServerIdentity(LPVOID ClientHello, DWORD ClientHelloSize, LPVOID ServerIdentity, LPVOID ServerIdentitySize, DWORD Flags)');
# my $ret = $SslGetServerIdentity->Call($ClientHello, $ClientHelloSize, $ServerIdentity, $ServerIdentitySize, $Flags);
# ClientHello : BYTE* -> LPVOID
# ClientHelloSize : DWORD -> DWORD
# ServerIdentity : BYTE** out -> LPVOID
# ServerIdentitySize : DWORD* out -> LPVOID
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。