/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*
* Contributor(s):
*
* Portions Copyrighted 2009 Sun Microsystems, Inc.
*/
package org.netbeans.modules.keyring.gnome;
import static org.netbeans.modules.keyring.gnome.GnomeKeyringLibrary.GNOME_KEYRING_ITEM_GENERIC_SECRET;
import static org.netbeans.modules.keyring.gnome.GnomeKeyringLibrary.GnomeKeyringAttribute_SIZE;
import static org.netbeans.modules.keyring.gnome.GnomeKeyringLibrary.LIBRARY;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.netbeans.modules.keyring.gnome.GnomeKeyringLibrary.GnomeKeyringFound;
import org.netbeans.spi.keyring.KeyringProvider;
import com.sun.jna.Pointer;
public class GnomeProvider implements KeyringProvider {
private static final Logger LOG = Logger.getLogger(GnomeProvider.class.getName());
private static final String KEY = "key"; // NOI18N
public @Override boolean enabled() {
if (Boolean.getBoolean("netbeans.keyring.no.native")) {
LOG.fine("native keyring integration disabled");
return false;
}
boolean envVarSet = false;
for (String key : System.getenv().keySet()) {
if (key.startsWith("GNOME_KEYRING_")) { // NOI18N
envVarSet = true;
break;
}
}
if (!envVarSet) {
LOG.fine("no GNOME_KEYRING_* environment variable set");
return false;
}
String appName = "JOSM";
try {
// Need to do this somewhere, or we get warnings on console.
// Also used by confirmation dialogs to give the app access to the login keyring.
LIBRARY.g_set_application_name(appName);
if (!LIBRARY.gnome_keyring_is_available()) {
return false;
}
// #178571: try to read some key just to make sure gnome_keyring_find_password_sync is bound:
read("NoNeXiStEnT"); // NOI18N
return true;
} catch (Throwable t) {
LOG.log(Level.FINE, null, t);
return false;
}
}
public @Override char[] read(String key) {
Pointer[] found = new Pointer[1];
Pointer attributes = LIBRARY.g_array_new(0, 0, GnomeKeyringAttribute_SIZE);
try {
LIBRARY.gnome_keyring_attribute_list_append_string(attributes, KEY, key);
error(GnomeKeyringLibrary.LIBRARY.gnome_keyring_find_items_sync(GNOME_KEYRING_ITEM_GENERIC_SECRET, attributes, found));
} finally {
LIBRARY.gnome_keyring_attribute_list_free(attributes);
}
if (found[0] != null) {
try {
if (LIBRARY.g_list_length(found[0]) > 0) {
GnomeKeyringFound result = LIBRARY.g_list_nth_data(found[0], 0);
if (result != null) {
if (result.secret != null) {
return result.secret.toCharArray();
} else {
LOG.warning("#183670: GnomeKeyringFound.secret == null");
delete(key);
}
} else {
LOG.warning("#183670: GList<GnomeKeyringFound>[0].result == null");
}
}
} finally {
LIBRARY.gnome_keyring_found_list_free(found[0]);
}
}
return null;
}
public @Override void save(String key, char[] password, String description) {
Pointer attributes = LIBRARY.g_array_new(0, 0, GnomeKeyringAttribute_SIZE);
try {
LIBRARY.gnome_keyring_attribute_list_append_string(attributes, KEY, key);
int[] item_id = new int[1];
error(GnomeKeyringLibrary.LIBRARY.gnome_keyring_item_create_sync(
null, GNOME_KEYRING_ITEM_GENERIC_SECRET, description != null ? description : key, attributes, new String(password), true, item_id));
} finally {
LIBRARY.gnome_keyring_attribute_list_free(attributes);
}
}
public @Override void delete(String key) {
Pointer[] found = new Pointer[1];
Pointer attributes = LIBRARY.g_array_new(0, 0, GnomeKeyringAttribute_SIZE);
try {
LIBRARY.gnome_keyring_attribute_list_append_string(attributes, KEY, key);
error(GnomeKeyringLibrary.LIBRARY.gnome_keyring_find_items_sync(GNOME_KEYRING_ITEM_GENERIC_SECRET, attributes, found));
} finally {
LIBRARY.gnome_keyring_attribute_list_free(attributes);
}
if (found[0] == null) {
return;
}
int id;
try {
if (LIBRARY.g_list_length(found[0]) > 0) {
GnomeKeyringFound result = LIBRARY.g_list_nth_data(found[0], 0);
id = result.item_id;
} else {
id = 0;
}
} finally {
LIBRARY.gnome_keyring_found_list_free(found[0]);
}
if (id > 0) {
if ("SunOS".equals(System.getProperty("os.name")) && "5.10".equals(System.getProperty("os.version"))) { // #185698
save(key, new char[0], null); // gnome_keyring_item_delete(null, id, null, null, null) does not seem to do anything
} else {
error(GnomeKeyringLibrary.LIBRARY.gnome_keyring_item_delete_sync(null, id));
}
}
}
private static String[] ERRORS = {
"OK", // NOI18N
"DENIED", // NOI18N
"NO_KEYRING_DAEMON", // NOI18N
"ALREADY_UNLOCKED", // NOI18N
"NO_SUCH_KEYRING", // NOI18N
"BAD_ARGUMENTS", // NOI18N
"IO_ERROR", // NOI18N
"CANCELLED", // NOI18N
"KEYRING_ALREADY_EXISTS", // NOI18N
"NO_MATCH", // NOI18N
};
private static void error(int code) {
if (code != 0 && code != 9) {
LOG.log(Level.WARNING, "gnome-keyring error: {0}", ERRORS[code]);
}
}
}