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

BCryptDestroySecret

関数
CNGの共有シークレットオブジェクトを破棄する。
DLLbcrypt.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

NTSTATUS BCryptDestroySecret(
    BCRYPT_SECRET_HANDLE hSecret
);

パラメーター

名前方向説明
hSecretBCRYPT_SECRET_HANDLEinout破棄する BCRYPT_SECRET_HANDLE

戻り値の型: NTSTATUS

公式ドキュメント

BCryptSecretAgreement 関数を使用して作成されたシークレット合意ハンドルを破棄します。

戻り値

関数の成功または失敗を示すステータスコードを返します。

戻り値のコードには、以下のものが含まれますが、これらに限定されません。

戻り値のコード 説明
STATUS_SUCCESS
関数は成功しました。
STATUS_INVALID_HANDLE
hSecret パラメーターのハンドルが無効です。

解説(Remarks)

サポートされているアルゴリズムプロバイダーを使用する場合、BCryptDestroySecret はユーザーモードまたはカーネルモードのいずれからも呼び出すことができます。カーネルモードの呼び出し元は、PASSIVE_LEVEL IRQL または DISPATCH_LEVEL IRQL のいずれかで実行できます。現在の IRQL レベルが DISPATCH_LEVEL の場合、hSecret パラメーターで指定するハンドルは、BCRYPT_PROV_DISPATCH フラグを使用して開かれたプロバイダーが返すアルゴリズムハンドルから派生したものでなければなりません。

この関数をカーネルモードで呼び出すには、Driver Development Kit (DDK) に含まれる Cng.lib を使用します。Windows Server 2008 および Windows Vista: この関数をカーネルモードで呼び出すには、Ksecdd.lib を使用します。

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

各言語での呼び出し定義

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

NTSTATUS BCryptDestroySecret(
    BCRYPT_SECRET_HANDLE hSecret
);
[DllImport("bcrypt.dll", ExactSpelling = true)]
static extern int BCryptDestroySecret(
    IntPtr hSecret   // BCRYPT_SECRET_HANDLE in/out
);
<DllImport("bcrypt.dll", ExactSpelling:=True)>
Public Shared Function BCryptDestroySecret(
    hSecret As IntPtr   ' BCRYPT_SECRET_HANDLE in/out
) As Integer
End Function
' hSecret : BCRYPT_SECRET_HANDLE in/out
Declare PtrSafe Function BCryptDestroySecret Lib "bcrypt" ( _
    ByVal hSecret As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BCryptDestroySecret = ctypes.windll.bcrypt.BCryptDestroySecret
BCryptDestroySecret.restype = ctypes.c_int
BCryptDestroySecret.argtypes = [
    wintypes.HANDLE,  # hSecret : BCRYPT_SECRET_HANDLE in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('bcrypt.dll')
BCryptDestroySecret = Fiddle::Function.new(
  lib['BCryptDestroySecret'],
  [
    Fiddle::TYPE_VOIDP,  # hSecret : BCRYPT_SECRET_HANDLE in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "bcrypt")]
extern "system" {
    fn BCryptDestroySecret(
        hSecret: *mut core::ffi::c_void  // BCRYPT_SECRET_HANDLE in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("bcrypt.dll")]
public static extern int BCryptDestroySecret(IntPtr hSecret);
"@
$api = Add-Type -MemberDefinition $sig -Name 'bcrypt_BCryptDestroySecret' -Namespace Win32 -PassThru
# $api::BCryptDestroySecret(hSecret)
#uselib "bcrypt.dll"
#func global BCryptDestroySecret "BCryptDestroySecret" sptr
; BCryptDestroySecret hSecret   ; 戻り値は stat
; hSecret : BCRYPT_SECRET_HANDLE in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "bcrypt.dll"
#cfunc global BCryptDestroySecret "BCryptDestroySecret" sptr
; res = BCryptDestroySecret(hSecret)
; hSecret : BCRYPT_SECRET_HANDLE in/out -> "sptr"
; NTSTATUS BCryptDestroySecret(BCRYPT_SECRET_HANDLE hSecret)
#uselib "bcrypt.dll"
#cfunc global BCryptDestroySecret "BCryptDestroySecret" intptr
; res = BCryptDestroySecret(hSecret)
; hSecret : BCRYPT_SECRET_HANDLE in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	bcrypt = windows.NewLazySystemDLL("bcrypt.dll")
	procBCryptDestroySecret = bcrypt.NewProc("BCryptDestroySecret")
)

// hSecret (BCRYPT_SECRET_HANDLE in/out)
r1, _, err := procBCryptDestroySecret.Call(
	uintptr(hSecret),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS
function BCryptDestroySecret(
  hSecret: THandle   // BCRYPT_SECRET_HANDLE in/out
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptDestroySecret';
result := DllCall("bcrypt\BCryptDestroySecret"
    , "Ptr", hSecret   ; BCRYPT_SECRET_HANDLE in/out
    , "Int")   ; return: NTSTATUS
●BCryptDestroySecret(hSecret) = DLL("bcrypt.dll", "int BCryptDestroySecret(void*)")
# 呼び出し: BCryptDestroySecret(hSecret)
# hSecret : BCRYPT_SECRET_HANDLE in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef BCryptDestroySecretNative = Int32 Function(Pointer<Void>);
typedef BCryptDestroySecretDart = int Function(Pointer<Void>);
final BCryptDestroySecret = DynamicLibrary.open('bcrypt.dll')
    .lookupFunction<BCryptDestroySecretNative, BCryptDestroySecretDart>('BCryptDestroySecret');
// hSecret : BCRYPT_SECRET_HANDLE in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BCryptDestroySecret(
  hSecret: THandle   // BCRYPT_SECRET_HANDLE in/out
): Integer; stdcall;
  external 'bcrypt.dll' name 'BCryptDestroySecret';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BCryptDestroySecret"
  c_BCryptDestroySecret :: Ptr () -> IO Int32
-- hSecret : BCRYPT_SECRET_HANDLE in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bcryptdestroysecret =
  foreign "BCryptDestroySecret"
    ((ptr void) @-> returning int32_t)
(* hSecret : BCRYPT_SECRET_HANDLE in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library bcrypt (t "bcrypt.dll"))
(cffi:use-foreign-library bcrypt)

(cffi:defcfun ("BCryptDestroySecret" bcrypt-destroy-secret :convention :stdcall) :int32
  (h-secret :pointer))   ; BCRYPT_SECRET_HANDLE in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BCryptDestroySecret = Win32::API::More->new('bcrypt',
    'int BCryptDestroySecret(HANDLE hSecret)');
# my $ret = $BCryptDestroySecret->Call($hSecret);
# hSecret : BCRYPT_SECRET_HANDLE in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目