de.carne.security.jna.macos.SecurityLibrary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-security Show documentation
Java library providing security related functions
The newest version!
/*
 * Copyright (c) 2018-2019 Holger de Carne and contributors, All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package de.carne.security.jna.macos;

import org.eclipse.jdt.annotation.Nullable;

import com.sun.jna.Library;
import com.sun.jna.Pointer;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.PointerByReference;

/**
 * JNA interface to the required functions of the macOS' Security frameworks.
 */
public interface SecurityLibrary extends Library {

	/**
	 * See Apple Developer
	 * Documentation
	 *
	 * @param keychain see Apple Developer Documentation.
	 * @param serviceNameLength see Apple Developer Documentation.
	 * @param serviceName see Apple Developer Documentation.
	 * @param accountNameLength see Apple Developer Documentation.
	 * @param accountName see Apple Developer Documentation.
	 * @param passwordLength see Apple Developer Documentation.
	 * @param passwordData see Apple Developer Documentation.
	 * @param itemRef see Apple Developer Documentation.
	 * @return see Apple Developer Documentation.
	 */
	@SuppressWarnings({ "squid:S00100", "squid:S00107" })
	int/* OSStatus */ SecKeychainAddGenericPassword(@Nullable Pointer/* SecKeychainRef */ keychain,
			int/* UInt32 */ serviceNameLength, byte[]/* const char * */ serviceName, int/* UInt32 */ accountNameLength,
			byte[]/* const char * */ accountName, int/* UInt32 */ passwordLength, byte[]/* const void * */ passwordData,
			@Nullable Pointer/* ecKeychainItemRef _Nullable * */ itemRef);

	/**
	 * See Apple Developer
	 * Documentation
	 *
	 * @param itemRef see Apple Developer Documentation.
	 * @param attrList see Apple Developer Documentation.
	 * @param length see Apple Developer Documentation.
	 * @param data see Apple Developer Documentation.
	 * @return see Apple Developer Documentation.
	 */
	@SuppressWarnings({ "squid:S00100", "squid:S00107" })
	int/* OSStatus */ SecKeychainItemModifyContent(Pointer/* SecKeychainItemRef */ itemRef,
			@Nullable Pointer/* const SecKeychainAttributeList * */ attrList, int/* UInt32 */ length,
			byte[]/* const void * */ data);

	/**
	 * See Apple Developer
	 * Documentation
	 *
	 * @param keychainOrArray see Apple Developer Documentation.
	 * @param serviceNameLength see Apple Developer Documentation.
	 * @param serviceName see Apple Developer Documentation.
	 * @param accountNameLength see Apple Developer Documentation.
	 * @param accountName see Apple Developer Documentation.
	 * @param passwordLength see Apple Developer Documentation.
	 * @param passwordData see Apple Developer Documentation.
	 * @param itemRef see Apple Developer Documentation.
	 * @return see Apple Developer Documentation.
	 */
	@SuppressWarnings({ "squid:S00100", "squid:S00107" })
	int/* OSStatus */ SecKeychainFindGenericPassword(@Nullable Pointer/* CFTypeRef */ keychainOrArray,
			int/* UInt32 */ serviceNameLength, byte[]/* const char * */ serviceName, int/* UInt32 */ accountNameLength,
			byte[]/* const char * */ accountName, @Nullable IntByReference/* UInt32 * */ passwordLength,
			@Nullable PointerByReference/* void * _Nullable * */ passwordData,
			@Nullable PointerByReference/* SecKeychainItemRef _Nullable * */ itemRef);

	/**
	 * See Apple Developer Documentation
	 *
	 * @param itemRef see Apple Developer Documentation.
	 * @return see Apple Developer Documentation.
	 */
	@SuppressWarnings({ "squid:S00100", "squid:S00107" })
	int SecKeychainItemDelete(Pointer/* SecKeychainItemRef */ itemRef);

	/**
	 * See Apple Developer Documentation
	 *
	 * @param attrList see Apple Developer Documentation.
	 * @param data see Apple Developer Documentation.
	 * @return see Apple Developer Documentation.
	 */
	@SuppressWarnings({ "squid:S00100", "squid:S00107" })
	int/* OSStatus */ SecKeychainItemFreeContent(@Nullable Pointer/* SecKeychainAttributeList * */ attrList,
			@Nullable Pointer /* void * */ data);

	/**
	 * See Apple Developer Documentation
	 *
	 * @param status see Apple Developer Documentation.
	 * @param reserved see Apple Developer Documentation.
	 * @return see Apple Developer Documentation.
	 */
	@SuppressWarnings({ "squid:S00100", "squid:S00107" })
	@Nullable
	Pointer/* CFStringRef */ SecCopyErrorMessageString(int/* OSStatus */ status,
			@Nullable Pointer/* void * */ reserved);

}