Sunday, April 8, 2018

Handling EVE ESI Authentication with Spring Boot

Continuing on from my prior post on reading from the EVE ESI API with Java, today I provide some details on handing the EVE ESI authentication flow with Spring Boot.

With ESI, they expect your application to be a web application, whether it is one or not.  If it's not, things get more complicated.  The problem stems from their new flow where you are supposed to redirect to them for EVE sign on and then they redirect back to you with a code you use to obtain access to restricted data.  This is problematic if your application isn't a web application.

If you are using Java, this problem happens to be an ideal use for Spring Boot.  With Spring Boot, configuration is mostly a breeze and an application server like Tomcat can be easily embedded in your Spring Boot application to handle the redirect and callback.

First, a quick overview of the steps you need to take, then below I provide an example Controller class for a Spring Boot application that can handle all of this.

  1. Determine your IP address, pick a port, choose a callback request mapping, and build the URL for your application from all that.  (example: http://[your IP]:[port]/[request mapping]).  It is recommended you use https, but doing so will require additional setup I'm not going into here.
  2. Register your application at the EVE Developers Site, using the URL from the previous step as your application callback URL.
  3. Access your router and forward TCP for your port to the machine that will be running your application.
  4. Create your Spring Boot application.  Maven dependencies provided below the Controller example should you find it helpful.
  5. Run your application.  Following the controller flow intended for the example, you would have an index page with a link to your /launchSignOn page.  Clicking that should redirect to EVE where you sign in.  Following that, it should redirect back to your application, where your application then takes the code sent back, makes a post request to get an access token (which includes a refresh token you will want), and makes a request to get character info, and then do whatever.  If you are just trying to get a refresh token and character ID for a different application, it can just display the fresh token and character ID on the screen for your to copy down.

Example Spring Boot Controller 


@Controller
public class SampleController {

 // these variables could come from a properties file or elsewhere, shown here as constants 
 // just for the sake of this example
 private static final String SCOPE = "esi-markets.read_character_orders.v1";  // example
 private static final String MY_CLIENT_URL = "?/eveCallback";  // callback URL for your application
 private static final String MY_CLIENT_ID = "?";   // client ID for your registered EVE application
 private static final String MY_SECRET_KEY = "?";  // secret key for your registered EVE application
 private static final String STATE = "?";            // your application state, if any
 private static final String MY_REFRESH_TOKEN = "?";  // saved after first sign in for subsequent use
 
 /**
  * A start page, should you want one.  It could have links to /launchSignOn and /testRefreshToken
  * 
  * @return view page reference
  */
 @RequestMapping(value="/", method=RequestMethod.GET)
 public String startPage() {
  return "index";
 }
 
 /**
  * Begin authentication process.  This will redirect to EVE sign on which will later redirect back 
  * to /eveCallback.  The redirect URL you here should be the same as the one you entered for your
  * registered EVE application, and it should point to your callback request mapping.
  * 
  * @return redirect URL to EVE sign on
  */
 @RequestMapping(value="/launchSignOn", method=RequestMethod.GET)
 public String launchSignOn() {
  return "redirect:https://login.eveonline.com/oauth/authorize"
    + "?response_type=code"
    + "&redirect_uri=" + MY_CLIENT_URL
    + "&client_id=" + MY_CLIENT_ID
    + "&scope=" + SCOPE
    + "&state=" + STATE;
 }
 
 /**
  * EVE sign on should redirect back to here. Now you can send a post request to get an
  * access token (which also includes a refresh token you probably will want to save), and if needed,
  * you can make a request to obtain character details as well (in particular, you will probably
  * want the character ID).
  *  
  * @param model
  * @param code    the code you need to request an access token
  * @param state   your appliction state info, should match what you originally sent in the redirect
  * 
  * @return view page reference, which could display info you want to see about the token or character.
  */
 @RequestMapping(value="/eveCallback", method=RequestMethod.GET)
 public String catchCallback(ModelMap model, @RequestParam String code, @RequestParam String state) {
  // do something with your state if needed
  MoxyJsonConfig moxyJsonConfig = new MoxyJsonConfig();
  ContextResolver<MoxyJsonConfig> jsonConfigResolver = moxyJsonConfig.resolver();
  Feature basicAuth = HttpAuthenticationFeature.basic(MY_CLIENT_ID, MY_SECRET_KEY);
  Client client = ClientBuilder.newBuilder()
    .register(basicAuth)
    .register(jsonConfigResolver)
    .build();
  MultivaluedMap<String, String> formData = new MultivaluedHashMap<String, String>();
  formData.add("grant_type", "authorization_code");
  formData.add("code", code);
  AccessToken accessToken = client.target("https://login.eveonline.com/oauth/token")
    .request(MediaType.APPLICATION_JSON_TYPE)
    .post(Entity.form(formData), new GenericType<AccessToken>(){});
  Feature bearerAuth = OAuth2ClientSupport.feature(accessToken.getAccess_token());
  client = ClientBuilder.newBuilder()
    .register(bearerAuth)
    .register(jsonConfigResolver)
    .build();
  EveCharacter character = client.target("https://login.eveonline.com/oauth/verify")
    .request(MediaType.APPLICATION_JSON_TYPE)
    .get(new GenericType<EveCharacter>(){});
  model.put("accessToken", accessToken);
  model.put("character", character);
  return "showTokenAndCharacterId";
 }
 
 /**
  * Uses a previously stored refresh token to obtain a new access token and character information.
  * 
  * @param model
  * 
  * @return view page reference, could display whatever info you want to see about token or character.
  */
 @RequestMapping(value="/testRefreshToken", method=RequestMethod.GET)
 public String testRefreshToken(ModelMap model) {
  final MoxyJsonConfig moxyJsonConfig = new MoxyJsonConfig();
  final ContextResolver<MoxyJsonConfig> jsonConfigResolver = moxyJsonConfig.resolver();
  Feature basicAuth = HttpAuthenticationFeature.basic(MY_CLIENT_ID, MY_SECRET_KEY);
  Client client = ClientBuilder.newBuilder()
    .register(basicAuth)
    .register(jsonConfigResolver)
    .build();
  MultivaluedMap<String, String> formData = new MultivaluedHashMap<String, String>();  
  formData.add("grant_type", "refresh_token");
  formData.add("refresh_token", MY_REFRESH_TOKEN);
  AccessToken accessToken = client.target("https://login.eveonline.com/oauth/token")
    .request(MediaType.APPLICATION_JSON_TYPE)
    .post(Entity.form(formData), new GenericType<AccessToken>(){});
  Feature bearerAuth = OAuth2ClientSupport.feature(accessToken.getAccess_token());
  client = ClientBuilder.newBuilder()
    .register(bearerAuth)
    .register(jsonConfigResolver)
    .build();
  EveCharacter character = client.target("https://login.eveonline.com/oauth/verify")
    .request(MediaType.APPLICATION_JSON_TYPE)
    .get(new GenericType<EveCharacter>(){});
  model.put("accessToken", accessToken);
  model.put("character", character);
  return "showTokenAndCharacterId";
 }
}

Example Maven Dependencies


  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.1.RELEASE</version>
  </parent>
  <dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-tomcat</artifactId>
    </dependency>
    <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-webmvc</artifactId>
    </dependency>
    <dependency>
     <groupId>org.apache.tomcat.embed</groupId>
     <artifactId>tomcat-embed-jasper</artifactId> <!-- only needed if using JSP -->
     <scope>provided</scope>
    </dependency>
    <dependency>
     <groupId>org.glassfish.jersey.core</groupId>
     <artifactId>jersey-client</artifactId>
    </dependency>
    <dependency>
     <groupId>org.glassfish.jersey.inject</groupId>
     <artifactId>jersey-hk2</artifactId>
     <version>2.26</version>
    </dependency>
    <dependency>
     <groupId>org.glassfish.jersey.media</groupId>
     <artifactId>jersey-media-moxy</artifactId>
     <version>2.26</version>
    </dependency>
    <dependency>
     <groupId>org.glassfish.jersey.security</groupId>
     <artifactId>oauth2-client</artifactId>
     <version>2.26</version>
    </dependency>
  </dependencies>

Monday, March 26, 2018

Calling EVE OpenAPI with Java

If you are into Java and want a quick example of a way you can read data from the EVE OpenAPI, here is an example I wrote using Jersey 2.26.

import java.util.List;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.ContextResolver;

import org.glassfish.jersey.moxy.json.MoxyJsonConfig;

/**
 * Example of calling the EVE OpenAPI using Jersey 2.26.  Specific Jersey components needed
 * include jersey-client 2.26, jersey-hk2 2.26, and jersey-media-moxy 2.26.
 */
public class EveOpenAPIExample {

 // variable names need to match names from the EVE OpenAPI
 private static class Region {
  private String region_id;
  private String name;
  private List<String> constellations;
  private String description;
  public String getRegion_id() {
   return region_id;
  }
  public void setRegion_id(String region_id) {
   this.region_id = region_id;
  }
  public String getName() {
   return name;
  }
  public void setName(String name) {
   this.name = name;
  }
  public List<String> getConstellations() {
   return constellations;
  }
  public void setConstellations(List<String> constellations) {
   this.constellations = constellations;
  }
  public String getDescription() {
   return description;
  }
  public void setDescription(String description) {
   this.description = description;
  }
 }
 
 public static void main(String[] args) {

  // setup the service information we will need for the example
  final String target = "https://esi.tech.ccp.is/latest/";
  final String path = "universe/regions/{regionid}/";
  final String regionId = "10000002";
  final String dataSource = "tranquility";
  
  // create the client configured to use MOXy for JSON binding
  final MoxyJsonConfig moxyJsonConfig = new MoxyJsonConfig();
  final ContextResolver jsonConfigResolver = moxyJsonConfig.resolver();
  Client client = ClientBuilder.newBuilder()
   .register(jsonConfigResolver).build();
  
  // execute example call on EVE OpenAPI to read information on a region
  Region region = client.target(target)
   .path(path)
   .resolveTemplate("regionid", regionId)
   .queryParam("datasource", dataSource)
   .request(MediaType.APPLICATION_JSON_TYPE)
   .get(new GenericType<Region>(){}); 
  
  // utilize the data
  System.out.println("Read information for region " + region.getName());
  
  System.exit(0);
 }
}

Monday, March 12, 2018

Planetary Interaction Tables

If you haven't tried it, Planetary Interaction is a great way to supplement your income, produce supplies you may need, and add some variety to your Eve experience. The key thing you need to know is what supplies can be created and what the "recipes" are for each. There are some great pages made by others that provide this information, but in my effort to host more of this information myself as well, I've provided some recipe tables here.

To find planets you are interested in close to the area you want to operate in, try using the Dotlan Planet Range tool.

1st Level RefinedRaw ResourceBarrenGasIceLavaOceanicPlasmaStormTemp.
BacteriaMicro Organisms X X X X
BiofuelsCarbon Compounds X X X
BiomassPlanktic Colonies X X
Chiral StructuresNon-CS Crystals X X
ElectrolytesIonic Solutions X X
Industrial FibersAutotrophs X
Oxidizing CompoundReactive Gas X
OxygenNoble Gas XX X
PlasmoidsSuspended Plasma X XX
Precious MetalsNoble Metals X X
ProteinsComplex Organisms X X
Reactive MetalsBase Metals XX X XX
SiliconFelsic Magma X
Toxic MetalsHeavy Metals XX X
WaterAqueous Liquids XXX X XX

2nd Level Refined1st Level Refined1st Level Refined
Biocells Biofuels+Precious Metals
Construction Blocks Reactive Metals+Toxic Metals
Consumer Electronics Toxic Metals+Chiral Structures
Coolant Water+Electrolytes
Enriched Uranium Toxic Metals+Precious Metals
Fertilizer Proteins+Bacteria
Gen Enhanced LivestockProteins+Biomass
Livestock Biofuels+Proteins
Mechanical Parts Reactive Metals+Precious Metals
Microfiber Shielding Industrial Fibers+Silicon
Miniature Electronics Silicon+Chiral Structures
Nanites Reactive Metals+Bacteria
Oxides Oxygen+Oxidizing Compound
Polyaramids Industrial Fibers+Oxidizing Compound
Polytextiles Industrial Fibers+Biofuels
Rocket Fuel Electrolytes+Plasmoids
Silicate Glass Silicon+Oxidizing Compound
Superconductors Water+Plasmoids
Supertensile Plastics Oxygen+Biomass
Synthetic Oil Electrolytes+Oxygen
Test Cultures Water+Bacteria
Transmitter Chiral Structures+Plasmoids
Viral Agent Bacteria+Biomass
Water-Cooled CPU Water+Reactive Metals

3rd Level Refined2nd Level Refined2nd Level Refined2nd Level Refined
Biotech Research Reports Construction Blocks+Livestock+Nanites
Camera Drones Rocket Fuel+Silicate Glass
Condensates Coolant+Oxides
Cryoprotectant Solution Fertilizer+Synthetic Oil+Test Cultures
Data Chips Microfiber Shielding+Supertensile Plastics
Gel-Matrix Biopaste Biocells+Oxides+Superconductors
Guidance Systems Transmitter+Water-Cooled CPU
Hazmat Detection Systems Polytextiles+Transmitter+Viral Agent
Hermetic Membranes Gen. Enhanced Livestock+Polyaramids
High-Tech Transmitters Polyaramids+Transmitter
Industrial Explosives Fertilizer+Polytextiles
Neocoms Biocells+Silicate Glass
Nuclear Reactors Enriched Uranium+Microfiber Shielding
Planetary Vehicles Mechanical Parts+Miniature Electronics+Supertensile Plastics
Robotics Consumer Electronics+Mechanical Parts
Smarfab Units Construction Blocks+Miniature Electronics+
Supercomputers Consumer Electronics+Coolant+Water-Cooled CPU
Synthetic Synapses Supertensile Plastics+Test Cultures
Transcranial MicrocontrollersBiocells+Nanites
Ukomi Super Conductors Superconductors+Synthetic Oil
Vaccines Livestock+Viral Agent

4th Level Refined3rd Level Refined3rd Level RefinedMisc. Refined (Level)
Broadcast Node Data Chips+High-Tech Transmitters+Neocoms (3rd)
Integrity Response Drones Gel-Matrix Biopaste+Hazmat Detection Systems+Planetary Vehicles (3rd)
Nano-Factory Industrial Explosives+Ukomi Super Conductors+Reactive Metals (1st)
Organic Mortar Applicators Condensates+Robotics+Bacteria (1st)
Recursive Computing Module Guidance Systems+Synthetic Synapses+Transcranial Microcontrollers (3rd)
Self-Harmonizing Power CoreCamera Drones+Hermetic Membranes+Nuclear Reactors (3rd)
Sterile Conduits Smartfab Units+Vaccines+Water (1st)
Wetware Mainframe Biotech Research Reports+Cryoprotectant Solution+Supercomputers (3rd)

Sunday, February 4, 2018

New Reference Category

I am adding a new category to this blog site named Reference. It is intended to be the quick link to information I find useful to reference while actually playing Eve. So while playing, a visitor can click the Reference category, and have all the most useful blog posts up for reference while playing. Feel free to provide feedback about what other topics or prior blog posts you think would be useful to include in this category.

Note that if you click the category from the side bar, it will not show all posts.  You will have to click the link to view older posts to see the older ones.  I'm trying to figure out how to show them all on the same page without that additional hassle, but so far I haven't figured out how.  If necessary, I will just go back and repost all the old posts so that they appear in the same date range and will all appear together, but I'm going to spend a little more time researching first to see if I can fix it without such a hackish workaround.

 Also, don't forget that I also have a Tools and Programming category that can also be useful, though those aren't necessarily needed on a regular basis, so most of them will most likely not also be included under Reference.

Monday, January 22, 2018

NPC Damage Types and Weaknesses

This year, I'm going to try to post more immediately useful Eve information.  Even though it's available many other places on the web already, I want my own set of pages hosted here that provide all the reference information of interest.  Today that means a table of NPC damage types and weaknesses.

NPCDamage TypeWeakness Type
Faction EMKiThExEMKiThExShip Alias
Amarr X X O
Angel X X X X OGist
Blood RaiderX X O Corp
Caldari X X O
Gallente X X O
Gurista X X O
Khanid X X O
Minmatar X X X X O
Mordu X X O
Rogue Drone X X X X O
Sansha X X O
Serpentis X X O Core

Thursday, January 18, 2018

More Bacon

Do you feel it?  Do you feel it?  I'm feeling it.  Eve needs more Bacon.

The Bacon is back.

I need a bit of a refresher, so my first few weeks might be light weight activity, and I'm not sure how much AG I'll be involved in, if any, but I just can't stay away from a game where I can fit and fly space ships.  And I have some ideas on some new things I'd like to do.  Real life often requires my attention and pulls me away from games, but I'm going to try to carve out a little time again for Eve, as it can be quite fun.

While I can't speak for how much or even if I will involve myself with AG again, I will as always remain NRDS in nullsec space.  That's just how I roll.  I want to remain careful that I don't attack anyone who is not actually interested in combat.  For the sake of all capsuleers in Eve, commerce should remain unimpeded among non-warring factions.  It just makes for a better game with happier, wealthier players who will in turn be able to buy more ships and fittings and be more inclined to engage in entertaining and mutually desired combat.

That said, I don't expect others to follow my ways.  My only *real* beef remains with the true griefers who delight not in playing the game but in upsetting others and generally making Eve a less fun place to be.  To all of those folks, I offer you my one finger salute, but with a genuine hope that you some day learn to be better people.  To everyone else, I look forward to seeing you out among the stars again.

Fly with honor,

Scott Bacon

Wednesday, July 20, 2016

Buy One Month Get One Free

I checked my account status today and saw they currently have a special offer -- buy one month, get one free.  So 2 months for about $15.  Not sure how long that deal has been running nor how much longer it will be available, but I am tempted to resub for a couple of months to take advantage of the offer.  $7.50 a month sounds pretty good.

If you would like to see me back in action, shoot me an email or comment on this post and let me know!  I do miss the action sometimes.

Scott Bacon
Loyal supporter of Silent Infinity and NRDS null space