org.gluu.credmanager.plugins.authnmethod.service.SGService クラス

org.gluu.credmanager.plugins.authnmethod.service.SGService の継承関係図

org.gluu.credmanager.plugins.authnmethod.service.SGService 連携図

公開メンバ関数
void	reloadConfiguration ()
int	getDevicesTotal (String userId, boolean active)
List< SuperGluuDevice >	getDevices (String userId, boolean active)
SGConfig	getConf ()
String	generateRequest (String userName, String code, String remoteIp)
SuperGluuDevice	getLatestSuperGluuDevice (String userId, long time)
boolean	isDeviceUnique (SuperGluuDevice dev, String userId) throws Exception
boolean	updateDevice (FidoDevice device)
boolean	removeDevice (FidoDevice device)
int	getDevicesTotal (String appId, String userId, boolean active)

関数
public< T extends FidoDevice > T	getLatestFidoDevice (String userId, long time, String oxApp, Class< T > clazz) throws Exception
private< T extends FidoDevice > List< T >	getDevices (String userId, boolean active, String oxApplication, Class< T > clazz) throws Exception
< T extends FidoDevice > List< T >	getSortedDevices (String userId, boolean active, String appId, Class< T > clazz)
private< T extends FidoDevice > T	getRecentlyCreatedDevice (List< T > devices, long time)

変数
MainSettings	settings

非公開メンバ関数
void	inited ()

非公開変数類
Logger	logger
LdapService	ldapService
SGConfig	conf
ObjectMapper	mapper

静的非公開変数類
static final String	GEOLOCATION_URL_PATTERN = "http://ip-api.com/json/{0}?fields=regionName,country,city,status,message"
static final int	GEO_REQ_TIMEOUT = 5000

詳解

An app. scoped bean that encapsulates logic needed to enroll supergluu devices

関数詳解

generateRequest()

String org.gluu.credmanager.plugins.authnmethod.service.SGService.generateRequest ( String  userName, String  code, String  remoteIp  )

inline

Builds a string that encodes information in order to display a QR code

引数

userName	Username string
code	An enrollment code associated to the code
remoteIp	An IP address to encode in the request (possibly null)

戻り値

A string encoded in JSon format with the information for QR code display

                                                                                 {

        logger.info("Beginning registration request with user={}, ip={}", userName, remoteIp);

        Map<String, String> reqAsMap = new HashMap<>();
        reqAsMap.put("username", userName);
        reqAsMap.put("app", conf.getAppId());
        reqAsMap.put("issuer", ldapService.getIssuerUrl());
        reqAsMap.put("created", LocalDateTime.now().format(DateTimeFormatter.ISO_LOCAL_DATE_TIME));
        reqAsMap.put("enrollment", code);
        reqAsMap.put("method", "enroll");

        if (remoteIp != null) {   //Add  geolocation information only if we have an IP available
            reqAsMap.put("req_ip", remoteIp);

            JsonNode geolocation = WebUtils.getGeoLocation(remoteIp, GEOLOCATION_URL_PATTERN, GEO_REQ_TIMEOUT);
            if (geolocation != null) {
                String reqLocation = Stream.of("country", "regionName", "city").map(key -> geolocation.get(key).asText())
                        .reduce("", (acc, next) -> acc + ", " + next);
                reqAsMap.put("req_loc", reqLocation.substring(2)); //Drop space+comma at the beginning
            }
        }

        String request = null;
        try {
            request = mapper.writeValueAsString(reqAsMap);
            logger.debug("Super Gluu request is {}", request);
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return request;

    }

getConf()

SGConfig org.gluu.credmanager.plugins.authnmethod.service.SGService.getConf ( )

inline

                              {
        return conf;
    }

getDevices() [1/2]

List<SuperGluuDevice> org.gluu.credmanager.plugins.authnmethod.service.SGService.getDevices ( String  userId, boolean  active  )

inline

                                                                           {
        return getSortedDevices(userId, active, conf.getAppId(), SuperGluuDevice.class);
    }

getDevices() [2/2]

private<T extends FidoDevice> List<T> org.gluu.credmanager.plugins.authnmethod.service.FidoService.getDevices ( String  userId, boolean  active, String  oxApplication, Class< T >  clazz  ) throws Exception

inlinepackageinherited

Returns a list of FidoDevice instances found under the given branch that matches the oxApplication value given and whose oxStatus attribute equals to "active"

引数

userId
oxApplication	Value to match for oxApplication attribute (see LDAP object class oxDeviceRegistration)
clazz	Any subclass of FidoDevice
<T>

戻り値

List of FidoDevices

                                                                                                                                            {

        List<T> devices = new ArrayList<>();
        List<oxDeviceRegistration> list = getRegistrations(oxApplication, userId, active);

        for (oxDeviceRegistration deviceRegistration : list) {
            T device = clazz.getConstructor().newInstance();

            if (clazz.equals(SuperGluuDevice.class)) {
                //DeviceData class is annotated with org.codehaus and has no default constructor so using normal mapper gives trouble
                DeviceData data = codehausMapper.readValue(deviceRegistration.getDeviceData(), DeviceData.class);
                ((SuperGluuDevice) device).setDeviceData(data);
            }
            device.setApplication(deviceRegistration.getOxApplication());
            device.setNickName(deviceRegistration.getDisplayName());
            device.setStatus(deviceRegistration.getOxStatus());
            device.setId(deviceRegistration.getOxId());
            device.setCreationDate(deviceRegistration.getCreationDate());
            device.setCounter(deviceRegistration.getOxCounter());

            devices.add(device);
        }
        return devices;

    }

getDevicesTotal() [1/2]

int org.gluu.credmanager.plugins.authnmethod.service.FidoService.getDevicesTotal ( String  appId, String  userId, boolean  active  )

inlineinherited

                                                                            {

        int total = 0;
        try {
            total = getRegistrations(appId, userId, active).size();
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return total;

    }

getDevicesTotal() [2/2]

int org.gluu.credmanager.plugins.authnmethod.service.SGService.getDevicesTotal ( String  userId, boolean  active  )

inline

                                                              {
        return getDevicesTotal(conf.getAppId(), userId, active);
    }

getLatestFidoDevice()

public<T extends FidoDevice> T org.gluu.credmanager.plugins.authnmethod.service.FidoService.getLatestFidoDevice ( String  userId, long  time, String  oxApp, Class< T >  clazz  ) throws Exception

inlinepackageinherited

                                                                                                                                 {
        List<T> list = getDevices(userId, true, oxApp, clazz);
        logger.debug("getLatestFidoDevice. list is {}", list.stream().map(FidoDevice::getId).collect(Collectors.toList()).toString());
        return getRecentlyCreatedDevice(list, time);
    }

getLatestSuperGluuDevice()

SuperGluuDevice org.gluu.credmanager.plugins.authnmethod.service.SGService.getLatestSuperGluuDevice ( String  userId, long  time  )

inline

Returns the most recently added (with respect to the timestamp passed) Super Gluu device for the user in question

引数

userId
time	Timestamp (milliseconds from the "epoch")

戻り値

A SuperGluuDevice object or null if no device could be found. Device has to have counter=-1 and no displayName yet

                                                                              {

        SuperGluuDevice sg = null;
        try {
            String appId = conf.getAppId();
            sg = getLatestFidoDevice(userId, time, appId, SuperGluuDevice.class);

            logger.trace("getLatestSuperGluuDevice. sg id is {}", sg == null ? -1 : sg.getId());
            if (sg != null && (sg.getNickName() != null || sg.getCounter() >= 0)) {
                sg = null;    //should have no name and counter must be -1
            }
            logger.trace("getLatestSuperGluuDevice. sg is null {}", sg == null);
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return sg;

    }

getRecentlyCreatedDevice()

private<T extends FidoDevice> T org.gluu.credmanager.plugins.authnmethod.service.FidoService.getRecentlyCreatedDevice ( List< T >  devices, long  time  )

inlinepackageinherited

Chooses one device from a list of devices, such that its creation time is the closest to the timestamp given

引数

devices	A non-null list of fido devices
time	A timestamp as milliseconds elapsed from the "epoch"
<T>

戻り値

The best matching device (only devices added before the time supplied are considered). Null if no suitable device could be found

                                                                                          {

        long[] diffs = devices.stream().mapToLong(key -> time - key.getCreationDate().getTime()).toArray();

        logger.trace("getRecentlyCreatedDevice. diffs {}", Arrays.asList(diffs));
        //Search for the smallest time difference
        int i;
        Pair<Long, Integer> min = new Pair<>(Long.MAX_VALUE, -1);
        //it always holds that diffs.length==devices.size()
        for (i = 0; i < diffs.length; i++) {
            if (diffs[i] >= 0 && min.getX() > diffs[i]) {  //Only search non-negative differences
                min = new Pair<>(diffs[i], i);
            }
        }

        i = min.getY();
        return i == -1 ? null : devices.get(i);

    }

getSortedDevices()

<T extends FidoDevice> List<T> org.gluu.credmanager.plugins.authnmethod.service.FidoService.getSortedDevices ( String  userId, boolean  active, String  appId, Class< T >  clazz  )

inlinepackageinherited

                                                                                                                 {

        List<T> devices = new ArrayList<>();
        try {
            devices = getDevices(userId, active, appId, clazz).stream().sorted().collect(Collectors.toList());
            logger.trace("getDevices. User '{}' has {}", userId, devices.stream().map(FidoDevice::getId).collect(Collectors.toList()));
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return devices;
    }

inited()

void org.gluu.credmanager.plugins.authnmethod.service.SGService.inited ( )

inlineprivate

                          {
        reloadConfiguration();
        mapper = new ObjectMapper();
    }

isDeviceUnique()

boolean org.gluu.credmanager.plugins.authnmethod.service.SGService.isDeviceUnique ( SuperGluuDevice  dev, String  userId  ) throws Exception

inline

Determines if the device passed is enrolled exactly once or more times

引数

dev	A SuperGluuDevice instance
userId	A reference to a user

戻り値

Boolean value indicating whether a device with this device's UUID is enrolled once for some user

例外

Exception

If the device is not even enrolled

                                                                                       {

        boolean unique = false;
        String uiid = dev.getDeviceData().getUuid();
        List<String> uuids = getDevices(userId, true).stream().map(SuperGluuDevice::getDeviceData)
                .map(DeviceData::getUuid).collect(Collectors.toList());

        logger.trace("isSGDeviceUnique. All SG user's devices {}", uuids.toString());
        int size = (int) uuids.stream().filter(uuid -> uuid.equals(uiid)).count();
        if (size == 0) {
            throw new Exception(Labels.getLabel("app.error_uniqueness", new String[] { uiid }));
        } else if (size == 1) {
            unique = true;
        }
        return unique;

    }

reloadConfiguration()

void org.gluu.credmanager.plugins.authnmethod.service.SGService.reloadConfiguration ( )

inline

                                      {
        String acr = SuperGluuExtension.ACR;

        Map<String, String> props = ldapService.getCustScriptConfigProperties(acr);
        if (props == null) {
            logger.warn("Config. properties for custom script '{}' could not be read. Features related to {} will not be accessible",
                    acr, acr.toUpperCase());
        } else {
            conf = SGConfig.get(props);
            if (conf != null) {
                conf.setAppId(ldapService.getCustScriptConfigProperties(ConfigurationHandler.DEFAULT_ACR).get("supergluu_app_id"));
            }
        }

    }

removeDevice()

boolean org.gluu.credmanager.plugins.authnmethod.service.FidoService.removeDevice ( FidoDevice  device )

inlineinherited

                                                   {

        boolean success = false;
        oxDeviceRegistration deviceRegistration = getDeviceRegistrationFor(device);
        if (deviceRegistration != null) {
            success = ldapService.delete(deviceRegistration, oxDeviceRegistration.class);
        }
        return success;

    }

updateDevice()

boolean org.gluu.credmanager.plugins.authnmethod.service.FidoService.updateDevice ( FidoDevice  device )

inlineinherited

                                                   {

        boolean success = false;
        oxDeviceRegistration deviceRegistration = getDeviceRegistrationFor(device);
        if (deviceRegistration != null) {
            deviceRegistration.setDisplayName(device.getNickName());
            success = ldapService.modify(deviceRegistration, oxDeviceRegistration.class);
        }
        return success;

    }

メンバ詳解

conf

SGConfig org.gluu.credmanager.plugins.authnmethod.service.SGService.conf

private

GEO_REQ_TIMEOUT

final int org.gluu.credmanager.plugins.authnmethod.service.SGService.GEO_REQ_TIMEOUT = 5000

staticprivate

GEOLOCATION_URL_PATTERN

final String org.gluu.credmanager.plugins.authnmethod.service.SGService.GEOLOCATION_URL_PATTERN = "http://ip-api.com/json/{0}?fields=regionName,country,city,status,message"

staticprivate

ldapService

LdapService org.gluu.credmanager.plugins.authnmethod.service.SGService.ldapService

private

logger

Logger org.gluu.credmanager.plugins.authnmethod.service.SGService.logger

private

mapper

ObjectMapper org.gluu.credmanager.plugins.authnmethod.service.SGService.mapper

private

settings

MainSettings org.gluu.credmanager.plugins.authnmethod.service.FidoService.settings

packageinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/cred-manager/app/src/main/java/org/gluu/credmanager/plugins/authnmethod/service/SGService.java