ホーム › Security.Authorization › ConvertStringSecurityDescriptorToSecurityDescriptorW

ConvertStringSecurityDescriptorToSecurityDescriptorW

関数

SDDL文字列をセキュリティ記述子に変換する。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL ConvertStringSecurityDescriptorToSecurityDescriptorW(
    LPCWSTR StringSecurityDescriptor,
    DWORD StringSDRevision,
    PSECURITY_DESCRIPTOR* SecurityDescriptor,
    DWORD* SecurityDescriptorSize   // optional
);

パラメーター

名前	型	方向	説明
StringSecurityDescriptor	LPCWSTR	in	変換対象の文字列形式セキュリティ記述子を格納した、null 終端文字列へのポインター。
StringSDRevision	DWORD	in	StringSecurityDescriptor 文字列のリビジョンレベルを指定します。現在、この値は SDDL_REVISION_1 でなければなりません。
SecurityDescriptor	PSECURITY_DESCRIPTOR*	out	変換後のセキュリティ記述子へのポインターを受け取る変数へのポインター。返されるセキュリティ記述子は自己相対形式 (self-relative) です。返されたバッファーを解放するには、 LocalFree 関数を呼び出してください。セキュリティ記述子を絶対形式セキュリティ記述子 (absolute security descriptor) に変換するには、 MakeAbsoluteSD 関数を使用してください。
SecurityDescriptorSize	DWORD*	outoptional	変換後のセキュリティ記述子のサイズ (バイト単位) を受け取る変数へのポインター。このパラメーターには NULL を指定できます。

戻り値の型: BOOL

公式ドキュメント

文字列形式のセキュリティ記述子を、有効かつ機能するセキュリティ記述子に変換します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。GetLastError は次のいずれかのエラーコードを返すことがあります。

戻りコード	説明
ERROR_INVALID_PARAMETER	パラメーターが無効です。
ERROR_UNKNOWN_REVISION	SDDL のリビジョンレベルが無効です。
ERROR_NONE_MAPPED	入力されたセキュリティ記述子文字列に含まれるセキュリティ識別子 (SID) が、アカウント検索操作で見つかりませんでした。

解説(Remarks)

ace_type が ACCESS_ALLOWED_OBJECT_ACE_TYPE であり、object_guid と inherit_object_guid のいずれにも GUID が指定されていない場合、ConvertStringSecurityDescriptorToSecurityDescriptor は ace_type を ACCESS_ALLOWED_ACE_TYPE に変換します。ace_type、object_guid、inherit_object_guid の各フィールドについては、Ace Strings を参照してください。

メモ

sddl.h ヘッダーは、ConvertStringSecurityDescriptorToSecurityDescriptor を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコード非依存のエイリアスの使用と、エンコード非依存ではないコードを混在させると、不整合が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL ConvertStringSecurityDescriptorToSecurityDescriptorW(
    LPCWSTR StringSecurityDescriptor,
    DWORD StringSDRevision,
    PSECURITY_DESCRIPTOR* SecurityDescriptor,
    DWORD* SecurityDescriptorSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ConvertStringSecurityDescriptorToSecurityDescriptorW(
    [MarshalAs(UnmanagedType.LPWStr)] string StringSecurityDescriptor,   // LPCWSTR
    uint StringSDRevision,   // DWORD
    IntPtr SecurityDescriptor,   // PSECURITY_DESCRIPTOR* out
    IntPtr SecurityDescriptorSize   // DWORD* optional, out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ConvertStringSecurityDescriptorToSecurityDescriptorW(
    <MarshalAs(UnmanagedType.LPWStr)> StringSecurityDescriptor As String,   ' LPCWSTR
    StringSDRevision As UInteger,   ' DWORD
    SecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR* out
    SecurityDescriptorSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' StringSecurityDescriptor : LPCWSTR
' StringSDRevision : DWORD
' SecurityDescriptor : PSECURITY_DESCRIPTOR* out
' SecurityDescriptorSize : DWORD* optional, out
Declare PtrSafe Function ConvertStringSecurityDescriptorToSecurityDescriptorW Lib "advapi32" ( _
    ByVal StringSecurityDescriptor As LongPtr, _
    ByVal StringSDRevision As Long, _
    ByVal SecurityDescriptor As LongPtr, _
    ByVal SecurityDescriptorSize As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ConvertStringSecurityDescriptorToSecurityDescriptorW = ctypes.windll.advapi32.ConvertStringSecurityDescriptorToSecurityDescriptorW
ConvertStringSecurityDescriptorToSecurityDescriptorW.restype = wintypes.BOOL
ConvertStringSecurityDescriptorToSecurityDescriptorW.argtypes = [
    wintypes.LPCWSTR,  # StringSecurityDescriptor : LPCWSTR
    wintypes.DWORD,  # StringSDRevision : DWORD
    ctypes.c_void_p,  # SecurityDescriptor : PSECURITY_DESCRIPTOR* out
    ctypes.POINTER(wintypes.DWORD),  # SecurityDescriptorSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ConvertStringSecurityDescriptorToSecurityDescriptorW = Fiddle::Function.new(
  lib['ConvertStringSecurityDescriptorToSecurityDescriptorW'],
  [
    Fiddle::TYPE_VOIDP,  # StringSecurityDescriptor : LPCWSTR
    -Fiddle::TYPE_INT,  # StringSDRevision : DWORD
    Fiddle::TYPE_VOIDP,  # SecurityDescriptor : PSECURITY_DESCRIPTOR* out
    Fiddle::TYPE_VOIDP,  # SecurityDescriptorSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn ConvertStringSecurityDescriptorToSecurityDescriptorW(
        StringSecurityDescriptor: *const u16,  // LPCWSTR
        StringSDRevision: u32,  // DWORD
        SecurityDescriptor: *mut *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR* out
        SecurityDescriptorSize: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool ConvertStringSecurityDescriptorToSecurityDescriptorW([MarshalAs(UnmanagedType.LPWStr)] string StringSecurityDescriptor, uint StringSDRevision, IntPtr SecurityDescriptor, IntPtr SecurityDescriptorSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ConvertStringSecurityDescriptorToSecurityDescriptorW' -Namespace Win32 -PassThru
# $api::ConvertStringSecurityDescriptorToSecurityDescriptorW(StringSecurityDescriptor, StringSDRevision, SecurityDescriptor, SecurityDescriptorSize)

#uselib "ADVAPI32.dll"
#func global ConvertStringSecurityDescriptorToSecurityDescriptorW "ConvertStringSecurityDescriptorToSecurityDescriptorW" wptr, wptr, wptr, wptr
; ConvertStringSecurityDescriptorToSecurityDescriptorW StringSecurityDescriptor, StringSDRevision, SecurityDescriptor, varptr(SecurityDescriptorSize)   ; 戻り値は stat
; StringSecurityDescriptor : LPCWSTR -> "wptr"
; StringSDRevision : DWORD -> "wptr"
; SecurityDescriptor : PSECURITY_DESCRIPTOR* out -> "wptr"
; SecurityDescriptorSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global ConvertStringSecurityDescriptorToSecurityDescriptorW "ConvertStringSecurityDescriptorToSecurityDescriptorW" wstr, int, sptr, var
; res = ConvertStringSecurityDescriptorToSecurityDescriptorW(StringSecurityDescriptor, StringSDRevision, SecurityDescriptor, SecurityDescriptorSize)
; StringSecurityDescriptor : LPCWSTR -> "wstr"
; StringSDRevision : DWORD -> "int"
; SecurityDescriptor : PSECURITY_DESCRIPTOR* out -> "sptr"
; SecurityDescriptorSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global ConvertStringSecurityDescriptorToSecurityDescriptorW "ConvertStringSecurityDescriptorToSecurityDescriptorW" wstr, int, sptr, sptr
; res = ConvertStringSecurityDescriptorToSecurityDescriptorW(StringSecurityDescriptor, StringSDRevision, SecurityDescriptor, varptr(SecurityDescriptorSize))
; StringSecurityDescriptor : LPCWSTR -> "wstr"
; StringSDRevision : DWORD -> "int"
; SecurityDescriptor : PSECURITY_DESCRIPTOR* out -> "sptr"
; SecurityDescriptorSize : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。